]> git.ipfire.org Git - thirdparty/cups.git/blame - backend/usb-darwin.c
Import CUPS v2.0.3
[thirdparty/cups.git] / backend / usb-darwin.c
CommitLineData
ef416fc2 1/*
a215cf84 2 * "$Id: usb-darwin.c 12529 2015-02-23 18:57:57Z msweet $"
1a18c85c
MS
3 *
4 * Copyright 2005-2014 Apple Inc. All rights reserved.
5 *
6 * IMPORTANT: This Apple software is supplied to you by Apple Computer,
7 * Inc. ("Apple") in consideration of your agreement to the following
8 * terms, and your use, installation, modification or redistribution of
9 * this Apple software constitutes acceptance of these terms. If you do
10 * not agree with these terms, please do not use, install, modify or
11 * redistribute this Apple software.
12 *
13 * In consideration of your agreement to abide by the following terms, and
14 * subject to these terms, Apple grants you a personal, non-exclusive
15 * license, under Apple's copyrights in this original Apple software (the
16 * "Apple Software"), to use, reproduce, modify and redistribute the Apple
17 * Software, with or without modifications, in source and/or binary forms;
18 * provided that if you redistribute the Apple Software in its entirety and
19 * without modifications, you must retain this notice and the following
20 * text and disclaimers in all such redistributions of the Apple Software.
21 * Neither the name, trademarks, service marks or logos of Apple Computer,
22 * Inc. may be used to endorse or promote products derived from the Apple
23 * Software without specific prior written permission from Apple. Except
24 * as expressly stated in this notice, no other rights or licenses, express
25 * or implied, are granted by Apple herein, including but not limited to
26 * any patent rights that may be infringed by your derivative works or by
27 * other works in which the Apple Software may be incorporated.
28 *
29 * The Apple Software is provided by Apple on an "AS IS" basis. APPLE
30 * MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION
31 * THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS
32 * FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND
33 * OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.
34 *
35 * IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
36 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
37 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
38 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,
39 * MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED
40 * AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),
41 * STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGE.
43 */
ef416fc2 44
45/*
09a101d6 46 * Include necessary headers.
ef416fc2 47 */
09a101d6 48
ef416fc2 49#include <stdio.h>
50#include <stdlib.h>
51#include <errno.h>
52#include <signal.h>
53#include <fcntl.h>
54#include <termios.h>
55#include <unistd.h>
ac884b6a 56#include <sys/stat.h>
e53920b9 57#include <sys/sysctl.h>
58#include <libgen.h>
09a101d6 59#include <mach/mach.h>
e53920b9 60#include <mach/mach_error.h>
61#include <mach/mach_time.h>
71e16022 62#include <cups/debug-private.h>
22c9029b 63#include <cups/file-private.h>
f7deaa1a 64#include <cups/sidechannel.h>
71e16022 65#include <cups/language-private.h>
db0bd74a 66#include "backend-private.h"
e53920b9 67#include <CoreFoundation/CoreFoundation.h>
68#include <IOKit/usb/IOUSBLib.h>
69#include <IOKit/IOCFPlugIn.h>
a469f8a5 70#include <libproc.h>
71f63681 71#include <asl.h>
749b1e90 72#include <spawn.h>
e53920b9 73#include <pthread.h>
ef416fc2 74
a215cf84
MS
75/*
76 * Include necessary headers.
77 */
78
749b1e90
MS
79extern char **environ;
80
f7deaa1a 81
acb056cb
MS
82/*
83 * DEBUG_WRITES, if defined, causes the backend to write data to the printer in
84 * 512 byte increments, up to 8192 bytes, to make debugging with a USB bus
85 * analyzer easier.
86 */
87
88#define DEBUG_WRITES 0
89
7cf5915e
MS
90/*
91 * WAIT_EOF_DELAY is number of seconds we'll wait for responses from
92 * the printer after we've finished sending all the data
93 */
94#define WAIT_EOF_DELAY 7
95#define WAIT_SIDE_DELAY 3
7dfedb92 96#define DEFAULT_TIMEOUT 5000L
ef416fc2 97
e53920b9 98#define USB_INTERFACE_KIND CFUUIDGetUUIDBytes(kIOUSBInterfaceInterfaceID190)
99#define kUSBLanguageEnglish 0x409
ef416fc2 100
09a101d6 101#define PRINTER_POLLING_INTERVAL 5 /* seconds */
102#define INITIAL_LOG_INTERVAL PRINTER_POLLING_INTERVAL
103#define SUBSEQUENT_LOG_INTERVAL 3 * INITIAL_LOG_INTERVAL
ef416fc2 104
09a101d6 105#define kUSBPrinterClassTypeID CFUUIDGetConstantUUIDWithBytes(NULL, 0x06, 0x04, 0x7D, 0x16, 0x53, 0xA2, 0x11, 0xD6, 0x92, 0x06, 0x00, 0x30, 0x65, 0x52, 0x45, 0x92)
106#define kUSBPrinterClassInterfaceID CFUUIDGetConstantUUIDWithBytes(NULL, 0x03, 0x34, 0x6D, 0x74, 0x53, 0xA3, 0x11, 0xD6, 0x9E, 0xA1, 0x76, 0x30, 0x65, 0x52, 0x45, 0x92)
ef416fc2 107
108#define kUSBClassDriverProperty CFSTR("USB Printing Class")
ef416fc2 109
84315f46 110#define kUSBGenericTOPrinterClassDriver CFSTR("/System/Library/Printers/Libraries/USBGenericPrintingClass.plugin")
e53920b9 111#define kUSBPrinterClassDeviceNotOpen -9664 /*kPMInvalidIOMContext*/
ef416fc2 112
a469f8a5
MS
113#define CRSetCrashLogMessage(m) _crc_make_setter(message, m)
114#define _crc_make_setter(attr, arg) (gCRAnnotations.attr = (uint64_t)(unsigned long)(arg))
115#define CRASH_REPORTER_CLIENT_HIDDEN __attribute__((visibility("hidden")))
116#define CRASHREPORTER_ANNOTATIONS_VERSION 4
117#define CRASHREPORTER_ANNOTATIONS_SECTION "__crash_info"
118
119struct crashreporter_annotations_t {
120 uint64_t version; // unsigned long
121 uint64_t message; // char *
122 uint64_t signature_string; // char *
123 uint64_t backtrace; // char *
124 uint64_t message2; // char *
125 uint64_t thread; // uint64_t
126 uint64_t dialog_mode; // unsigned int
127};
128
0fa6c7fa
MS
129CRASH_REPORTER_CLIENT_HIDDEN
130struct crashreporter_annotations_t gCRAnnotations
131 __attribute__((section("__DATA," CRASHREPORTER_ANNOTATIONS_SECTION)))
a469f8a5 132 = { CRASHREPORTER_ANNOTATIONS_VERSION, 0, 0, 0, 0, 0, 0 };
ef416fc2 133
e53920b9 134/*
135 * Section 5.3 USB Printing Class spec
136 */
137#define kUSBPrintingSubclass 1
138#define kUSBPrintingProtocolNoOpen 0
139#define kUSBPrintingProtocolUnidirectional 1
140#define kUSBPrintingProtocolBidirectional 2
a215cf84 141#define kUSBPrintingProtocolIPP 4
e53920b9 142
143typedef IOUSBInterfaceInterface190 **printer_interface_t;
ef416fc2 144
09a101d6 145typedef struct iodevice_request_s /**** Device request ****/
ef416fc2 146{
09a101d6 147 UInt8 requestType;
e53920b9 148 UInt8 request;
149 UInt16 value;
150 UInt16 index;
151 UInt16 length;
09a101d6 152 void *buffer;
e53920b9 153} iodevice_request_t;
154
09a101d6 155typedef union /**** Centronics status byte ****/
156{
e53920b9 157 char b;
09a101d6 158 struct
159 {
e53920b9 160 unsigned reserved0:2;
161 unsigned paperError:1;
162 unsigned select:1;
163 unsigned notError:1;
164 unsigned reserved1:3;
165 } status;
166} centronics_status_t;
167
09a101d6 168typedef struct classdriver_s /**** g.classdriver context ****/
ef416fc2 169{
170 IUNKNOWN_C_GUTS;
e53920b9 171 CFPlugInRef plugin; /* release plugin */
172 IUnknownVTbl **factory; /* Factory */
173 void *vendorReference; /* vendor class specific usage */
174 UInt32 location; /* unique location in bus topology */
175 UInt8 interfaceNumber; /* Interface number */
176 UInt16 vendorID; /* Vendor id */
177 UInt16 productID; /* Product id */
178 printer_interface_t interface; /* identify the device to IOKit */
a469f8a5 179 UInt8 outpipe; /* mandatory bulkOut pipe */
e53920b9 180 UInt8 inpipe; /* optional bulkIn pipe */
ef416fc2 181
e53920b9 182 /* general class requests */
09a101d6 183 kern_return_t (*DeviceRequest)(struct classdriver_s **printer, iodevice_request_t *iorequest, UInt16 timeout);
184 kern_return_t (*GetString)(struct classdriver_s **printer, UInt8 whichString, UInt16 language, UInt16 timeout, CFStringRef *result);
ef416fc2 185
e53920b9 186 /* standard printer class requests */
09a101d6 187 kern_return_t (*SoftReset)(struct classdriver_s **printer, UInt16 timeout);
188 kern_return_t (*GetCentronicsStatus)(struct classdriver_s **printer, centronics_status_t *result, UInt16 timeout);
189 kern_return_t (*GetDeviceID)(struct classdriver_s **printer, CFStringRef *devid, UInt16 timeout);
ef416fc2 190
e53920b9 191 /* standard bulk device requests */
09a101d6 192 kern_return_t (*ReadPipe)(struct classdriver_s **printer, UInt8 *buffer, UInt32 *count);
193 kern_return_t (*WritePipe)(struct classdriver_s **printer, UInt8 *buffer, UInt32 *count, Boolean eoj);
ef416fc2 194
e53920b9 195 /* interface requests */
09a101d6 196 kern_return_t (*Open)(struct classdriver_s **printer, UInt32 location, UInt8 protocol);
197 kern_return_t (*Abort)(struct classdriver_s **printer);
198 kern_return_t (*Close)(struct classdriver_s **printer);
ef416fc2 199
e53920b9 200 /* initialize and terminate */
09a101d6 201 kern_return_t (*Initialize)(struct classdriver_s **printer, struct classdriver_s **baseclass);
202 kern_return_t (*Terminate)(struct classdriver_s **printer);
ef416fc2 203
09a101d6 204} classdriver_t;
ef416fc2 205
a215cf84 206typedef Boolean (*iterator_callback_t)(void *refcon, io_service_t obj, CFStringRef deviceIDString, UInt32 deviceLocation, UInt8 interfaceNum, UInt8 alternateSetting);
ef416fc2 207
09a101d6 208typedef struct iterator_reference_s /**** Iterator reference data */
209{
e53920b9 210 iterator_callback_t callback;
211 void *userdata;
212 Boolean keepRunning;
213} iterator_reference_t;
ef416fc2 214
09a101d6 215typedef struct globals_s
216{
217 io_service_t printer_obj;
218 classdriver_t **classdriver;
219
220 pthread_mutex_t read_thread_mutex;
221 pthread_cond_t read_thread_cond;
222 int read_thread_stop;
223 int read_thread_done;
ef416fc2 224
09a101d6 225 pthread_mutex_t readwrite_lock_mutex;
226 pthread_cond_t readwrite_lock_cond;
227 int readwrite_lock;
ef416fc2 228
e53920b9 229 CFStringRef make;
230 CFStringRef model;
231 CFStringRef serial;
e53920b9 232 UInt32 location;
bc44d920 233 UInt8 interfaceNum;
a215cf84 234 UInt8 alternateSetting;
09a101d6 235
236 CFRunLoopTimerRef status_timer;
237
238 int print_fd; /* File descriptor to print */
239 ssize_t print_bytes; /* Print bytes read */
acb056cb
MS
240#if DEBUG_WRITES
241 ssize_t debug_bytes; /* Current bytes to read */
242#endif /* DEBUG_WRITES */
09a101d6 243
244 Boolean wait_eof;
245 int drain_output; /* Drain all pending output */
246 int bidi_flag; /* 0=unidirectional, 1=bidirectional */
7cf5915e
MS
247
248 pthread_mutex_t sidechannel_thread_mutex;
249 pthread_cond_t sidechannel_thread_cond;
250 int sidechannel_thread_stop;
251 int sidechannel_thread_done;
09a101d6 252} globals_t;
253
254
255/*
256 * Globals...
257 */
258
259globals_t g = { 0 }; /* Globals */
0fa6c7fa 260int Iterating = 0; /* Are we iterating the bus? */
ef416fc2 261
ef416fc2 262
e53920b9 263/*
264 * Local functions...
265 */
ef416fc2 266
a215cf84
MS
267static Boolean find_device_cb(void *refcon, io_service_t obj, CFStringRef deviceIDString, UInt32 deviceLocation, UInt8 interfaceNum, UInt8 alternateSetting);
268static Boolean list_device_cb(void *refcon, io_service_t obj, CFStringRef deviceIDString, UInt32 deviceLocation, UInt8 interfaceNum, UInt8 alternateSetting);
269
09a101d6 270static CFStringRef cfstr_create_trim(const char *cstr);
271static CFStringRef copy_value_for_key(CFStringRef deviceID, CFStringRef *keys);
321d8d57 272static kern_return_t load_classdriver(CFStringRef driverPath, printer_interface_t interface, classdriver_t ***printerDriver);
09a101d6 273static kern_return_t load_printerdriver(CFStringRef *driverBundlePath);
eac3a0a0 274static kern_return_t registry_close(void);
09a101d6 275static kern_return_t registry_open(CFStringRef *driverBundlePath);
eac3a0a0 276static kern_return_t unload_classdriver(classdriver_t ***classdriver);
a215cf84 277
09a101d6 278static void *read_thread(void *reference);
279static void *sidechannel_thread(void *reference);
09a101d6 280static void device_added(void *userdata, io_iterator_t iterator);
281static void get_device_id(cups_sc_status_t *status, char *data, int *datalen);
282static void iterate_printers(iterator_callback_t callBack, void *userdata);
db1f069b 283static void parse_options(char *options, char *serial, int serial_size, UInt32 *location, Boolean *wait_eof);
e53920b9 284static void setup_cfLanguage(void);
eac3a0a0 285static void soft_reset(void);
09a101d6 286static void status_timer_cb(CFRunLoopTimerRef timer, void *info);
71f63681
MS
287static void log_usb_class_driver(int is_64bit);
288#define IS_64BIT 1
289#define IS_NOT_64BIT 0
e53920b9 290
749b1e90 291#if defined(__i386__) || defined(__x86_64__)
f11a948a 292static pid_t child_pid; /* Child PID */
1a18c85c 293static void run_legacy_backend(int argc, char *argv[], int fd) __attribute__((noreturn)); /* Starts child backend process running as a ppc executable */
18ecb428 294#endif /* __i386__ || __x86_64__ */
6c48a6ca 295static void sigterm_handler(int sig); /* SIGTERM handler */
1a18c85c 296static void sigquit_handler(int sig, siginfo_t *si, void *unused) __attribute__((noreturn));
ef416fc2 297
e53920b9 298#ifdef PARSE_PS_ERRORS
299static const char *next_line (const char *buffer);
300static void parse_pserror (char *sockBuffer, int len);
301#endif /* PARSE_PS_ERRORS */
ef416fc2 302
a215cf84
MS
303static IOUSBInterfaceInterface220 **usb_interface220_for_service(io_service_t usbClass);
304static IOUSBDeviceInterface **usb_device_interface_for_device(io_service_t usbDevice);
305static CFStringRef printer_interface_deviceid(IOUSBInterfaceInterface220 **printer, UInt8 alternateSetting);
306static CFStringRef printer_interface_indexed_description(IOUSBInterfaceInterface220 ** printer, UInt8 index, UInt16 language);
307static CFStringRef deviceIDCopyManufacturer(CFStringRef deviceID);
308static CFStringRef deviceIDCopyModel(CFStringRef deviceID);
309static CFStringRef deviceIDCopySerialNumber(CFStringRef deviceID);
310
e53920b9 311#pragma mark -
ef416fc2 312
e53920b9 313/*
314 * 'list_devices()' - List all USB devices.
315 */
ef416fc2 316
e53920b9 317void list_devices()
ef416fc2 318{
09a101d6 319 iterate_printers(list_device_cb, NULL);
ef416fc2 320}
321
ef416fc2 322
e53920b9 323/*
324 * 'print_device()' - Print a file to a USB device.
325 */
ef416fc2 326
e53920b9 327int /* O - Exit status */
328print_device(const char *uri, /* I - Device URI */
329 const char *hostname, /* I - Hostname/manufacturer */
330 const char *resource, /* I - Resource/modelname */
db1f069b 331 char *options, /* I - Device options/serial number */
09a101d6 332 int print_fd, /* I - File descriptor to print */
e53920b9 333 int copies, /* I - Copies to print */
334 int argc, /* I - Number of command-line arguments (6 or 7) */
335 char *argv[]) /* I - Command-line arguments */
ef416fc2 336{
09a101d6 337 char serial[1024]; /* Serial number buffer */
338 OSStatus status; /* Function results */
acb056cb 339 IOReturn iostatus; /* Current IO status */
09a101d6 340 pthread_t read_thread_id, /* Read thread */
db1f069b 341 sidechannel_thread_id;/* Side-channel thread */
ac884b6a
MS
342 int have_sidechannel = 0; /* Was the side-channel thread started? */
343 struct stat sidechannel_info; /* Side-channel file descriptor info */
09a101d6 344 char print_buffer[8192], /* Print data buffer */
345 *print_ptr; /* Pointer into print data buffer */
346 UInt32 location; /* Unique location in bus topology */
347 fd_set input_set; /* Input set for select() */
348 CFStringRef driverBundlePath; /* Class driver path */
349 int countdown, /* Logging interval */
350 nfds; /* Number of file descriptors */
351 ssize_t total_bytes; /* Total bytes written */
352 UInt32 bytes; /* Bytes written */
353 struct timeval *timeout, /* Timeout pointer */
84315f46 354 tv; /* Time value */
7cf5915e 355 struct timespec cond_timeout; /* pthread condition timeout */
a469f8a5 356 struct sigaction action; /* Actions for POSIX signals */
e53920b9 357
db1f069b 358
321d8d57
MS
359 (void)uri;
360
a469f8a5
MS
361 /*
362 * Catch SIGQUIT to determine who is sending it...
363 */
364
365 memset(&action, 0, sizeof(action));
366 action.sa_sigaction = sigquit_handler;
367 action.sa_flags = SA_SIGINFO;
368 sigaction(SIGQUIT, &action, NULL);
369
ac884b6a
MS
370 /*
371 * See if the side-channel descriptor is valid...
372 */
373
374 have_sidechannel = !fstat(CUPS_SC_FD, &sidechannel_info) &&
375 S_ISSOCK(sidechannel_info.st_mode);
376
377 /*
378 * Localize using CoreFoundation...
379 */
380
e53920b9 381 setup_cfLanguage();
09a101d6 382
76cd9e37 383 parse_options(options, serial, sizeof(serial), &location, &g.wait_eof);
e53920b9 384
385 if (resource[0] == '/')
386 resource++;
387
09a101d6 388 g.print_fd = print_fd;
389 g.make = cfstr_create_trim(hostname);
390 g.model = cfstr_create_trim(resource);
391 g.serial = cfstr_create_trim(serial);
392 g.location = location;
e53920b9 393
7dfedb92
MS
394 if (!g.make || !g.model)
395 {
c7017ecc 396 fprintf(stderr, "DEBUG: Fatal USB error.\n");
0837b7e8
MS
397 _cupsLangPrintFilter(stderr, "ERROR",
398 _("There was an unrecoverable USB error."));
005dd1eb
MS
399
400 if (!g.make)
4d301e69 401 fputs("DEBUG: USB make string is NULL\n", stderr);
005dd1eb 402 if (!g.model)
4d301e69 403 fputs("DEBUG: USB model string is NULL\n", stderr);
005dd1eb
MS
404
405 return (CUPS_BACKEND_STOP);
7dfedb92
MS
406 }
407
e53920b9 408 fputs("STATE: +connecting-to-device\n", stderr);
409
09a101d6 410 countdown = INITIAL_LOG_INTERVAL;
411
412 do
413 {
414 if (g.printer_obj)
415 {
416 IOObjectRelease(g.printer_obj);
417 unload_classdriver(&g.classdriver);
418 g.printer_obj = 0x0;
419 g.classdriver = 0x0;
ef416fc2 420 }
ef416fc2 421
c0e1af83 422 fprintf(stderr, "DEBUG: Looking for '%s %s'\n", hostname, resource);
09a101d6 423
424 iterate_printers(find_device_cb, NULL);
e53920b9 425
c0e1af83 426 fputs("DEBUG: Opening connection\n", stderr);
411affcf 427
428 driverBundlePath = NULL;
09a101d6 429
430 status = registry_open(&driverBundlePath);
431
749b1e90 432#if defined(__i386__) || defined(__x86_64__)
e53920b9 433 /*
749b1e90
MS
434 * If we were unable to load the class drivers for this printer it's
435 * probably because they're ppc or i386. In this case try to run this
436 * backend as i386 or ppc executables so we can use them...
e53920b9 437 */
09a101d6 438 if (status == -2)
439 {
749b1e90 440 run_legacy_backend(argc, argv, print_fd);
e53920b9 441 /* Never returns here */
ef416fc2 442 }
749b1e90 443#endif /* __i386__ || __x86_64__ */
09a101d6 444
445 if (status == -2)
446 {
411affcf 447 /*
448 * If we still were unable to load the class drivers for this printer log
449 * the error and stop the queue...
450 */
451
09a101d6 452 if (driverBundlePath == NULL || !CFStringGetCString(driverBundlePath, print_buffer, sizeof(print_buffer), kCFStringEncodingUTF8))
453 strlcpy(print_buffer, "USB class driver", sizeof(print_buffer));
411affcf 454
c0e1af83 455 fputs("STATE: +apple-missing-usbclassdriver-error\n", stderr);
0837b7e8
MS
456 _cupsLangPrintFilter(stderr, "ERROR",
457 _("There was an unrecoverable USB error."));
005dd1eb 458 fprintf(stderr, "DEBUG: Could not load %s\n", print_buffer);
411affcf 459
460 if (driverBundlePath)
461 CFRelease(driverBundlePath);
462
005dd1eb 463 return (CUPS_BACKEND_STOP);
411affcf 464 }
465
71f63681
MS
466#ifdef __x86_64__
467 if (status == noErr && driverBundlePath != NULL && CFStringCompare(driverBundlePath, kUSBGenericTOPrinterClassDriver, 0) != kCFCompareEqualTo)
468 log_usb_class_driver(IS_64BIT);
469#endif /* __x86_64__ */
470
411affcf 471 if (driverBundlePath)
472 CFRelease(driverBundlePath);
e53920b9 473
09a101d6 474 if (status != noErr)
475 {
476 sleep(PRINTER_POLLING_INTERVAL);
e53920b9 477 countdown -= PRINTER_POLLING_INTERVAL;
09a101d6 478 if (countdown <= 0)
479 {
0837b7e8
MS
480 _cupsLangPrintFilter(stderr, "INFO",
481 _("Waiting for printer to become available."));
005dd1eb 482 fprintf(stderr, "DEBUG: USB printer status: 0x%08x\n", (int)status);
e53920b9 483 countdown = SUBSEQUENT_LOG_INTERVAL; /* subsequent log entries, every 15 seconds */
484 }
485 }
486 } while (status != noErr);
ef416fc2 487
e53920b9 488 fputs("STATE: -connecting-to-device\n", stderr);
ef416fc2 489
e53920b9 490 /*
18ecb428 491 * Now that we are "connected" to the port, ignore SIGTERM so that we
e53920b9 492 * can finish out any page data the driver sends (e.g. to eject the
18ecb428 493 * current page... Only ignore SIGTERM if we are printing data from
e53920b9 494 * stdin (otherwise you can't cancel raw jobs...)
495 */
ef416fc2 496
09a101d6 497 if (!print_fd)
498 {
e53920b9 499 memset(&action, 0, sizeof(action));
ef416fc2 500
e53920b9 501 sigemptyset(&action.sa_mask);
18ecb428 502 action.sa_handler = SIG_IGN;
e53920b9 503 sigaction(SIGTERM, &action, NULL);
e53920b9 504 }
ef416fc2 505
09a101d6 506 /*
ac884b6a 507 * Start the side channel thread if the descriptor is valid...
09a101d6 508 */
ef416fc2 509
09a101d6 510 pthread_mutex_init(&g.readwrite_lock_mutex, NULL);
511 pthread_cond_init(&g.readwrite_lock_cond, NULL);
512 g.readwrite_lock = 1;
f7deaa1a 513
ac884b6a 514 if (have_sidechannel)
09a101d6 515 {
7cf5915e
MS
516 g.sidechannel_thread_stop = 0;
517 g.sidechannel_thread_done = 0;
518
519 pthread_cond_init(&g.sidechannel_thread_cond, NULL);
520 pthread_mutex_init(&g.sidechannel_thread_mutex, NULL);
521
09a101d6 522 if (pthread_create(&sidechannel_thread_id, NULL, sidechannel_thread, NULL))
523 {
c7017ecc 524 fprintf(stderr, "DEBUG: Fatal USB error.\n");
0837b7e8
MS
525 _cupsLangPrintFilter(stderr, "ERROR",
526 _("There was an unrecoverable USB error."));
4d301e69 527 fputs("DEBUG: Couldn't create side-channel thread\n", stderr);
ef55b745 528 registry_close();
005dd1eb 529 return (CUPS_BACKEND_STOP);
09a101d6 530 }
531 }
f7deaa1a 532
09a101d6 533 /*
534 * Get the read thread going...
535 */
f7deaa1a 536
09a101d6 537 g.read_thread_stop = 0;
538 g.read_thread_done = 0;
f7deaa1a 539
09a101d6 540 pthread_cond_init(&g.read_thread_cond, NULL);
541 pthread_mutex_init(&g.read_thread_mutex, NULL);
f7deaa1a 542
09a101d6 543 if (pthread_create(&read_thread_id, NULL, read_thread, NULL))
544 {
c7017ecc 545 fprintf(stderr, "DEBUG: Fatal USB error.\n");
0837b7e8
MS
546 _cupsLangPrintFilter(stderr, "ERROR",
547 _("There was an unrecoverable USB error."));
4d301e69 548 fputs("DEBUG: Couldn't create read thread\n", stderr);
ef55b745 549 registry_close();
005dd1eb 550 return (CUPS_BACKEND_STOP);
e53920b9 551 }
ef416fc2 552
09a101d6 553 /*
554 * The main thread sends the print file...
555 */
f7deaa1a 556
09a101d6 557 g.drain_output = 0;
558 g.print_bytes = 0;
559 total_bytes = 0;
560 print_ptr = print_buffer;
ef416fc2 561
09a101d6 562 while (status == noErr && copies-- > 0)
563 {
0837b7e8 564 _cupsLangPrintFilter(stderr, "INFO", _("Sending data to printer."));
757d2cad 565
09a101d6 566 if (print_fd != STDIN_FILENO)
567 {
749b1e90 568 fputs("PAGE: 1 1\n", stderr);
09a101d6 569 lseek(print_fd, 0, SEEK_SET);
ef416fc2 570 }
571
09a101d6 572 while (status == noErr)
573 {
574 FD_ZERO(&input_set);
e53920b9 575
09a101d6 576 if (!g.print_bytes)
577 FD_SET(print_fd, &input_set);
f7deaa1a 578
09a101d6 579 /*
580 * Calculate select timeout...
581 * If we have data waiting to send timeout is 100ms.
582 * else if we're draining print_fd timeout is 0.
583 * else we're waiting forever...
584 */
585
586 if (g.print_bytes)
587 {
84315f46
MS
588 tv.tv_sec = 0;
589 tv.tv_usec = 100000; /* 100ms */
590 timeout = &tv;
09a101d6 591 }
592 else if (g.drain_output)
593 {
84315f46
MS
594 tv.tv_sec = 0;
595 tv.tv_usec = 0;
596 timeout = &tv;
09a101d6 597 }
598 else
599 timeout = NULL;
600
601 /*
602 * I/O is unlocked around select...
603 */
604
605 pthread_mutex_lock(&g.readwrite_lock_mutex);
606 g.readwrite_lock = 0;
607 pthread_cond_signal(&g.readwrite_lock_cond);
608 pthread_mutex_unlock(&g.readwrite_lock_mutex);
609
610 nfds = select(print_fd + 1, &input_set, NULL, NULL, timeout);
611
612 /*
613 * Reacquire the lock...
614 */
615
616 pthread_mutex_lock(&g.readwrite_lock_mutex);
617 while (g.readwrite_lock)
618 pthread_cond_wait(&g.readwrite_lock_cond, &g.readwrite_lock_mutex);
619 g.readwrite_lock = 1;
620 pthread_mutex_unlock(&g.readwrite_lock_mutex);
621
622 if (nfds < 0)
623 {
624 if (errno == EINTR && total_bytes == 0)
625 {
626 fputs("DEBUG: Received an interrupt before any bytes were "
4d301e69 627 "written, aborting\n", stderr);
ef55b745 628 registry_close();
f11a948a 629 return (CUPS_BACKEND_OK);
09a101d6 630 }
536bc2c6 631 else if (errno != EAGAIN && errno != EINTR)
09a101d6 632 {
0837b7e8
MS
633 _cupsLangPrintFilter(stderr, "ERROR",
634 _("Unable to read print data."));
005dd1eb 635 perror("DEBUG: select");
ef55b745
MS
636 registry_close();
637 return (CUPS_BACKEND_FAILED);
09a101d6 638 }
639 }
640
641 /*
642 * If drain output has finished send a response...
643 */
644
645 if (g.drain_output && !nfds && !g.print_bytes)
646 {
647 /* Send a response... */
648 cupsSideChannelWrite(CUPS_SC_CMD_DRAIN_OUTPUT, CUPS_SC_STATUS_OK, NULL, 0, 1.0);
649 g.drain_output = 0;
650 }
651
652 /*
653 * Check if we have print data ready...
654 */
655
656 if (FD_ISSET(print_fd, &input_set))
657 {
acb056cb
MS
658#if DEBUG_WRITES
659 g.debug_bytes += 512;
660 if (g.debug_bytes > sizeof(print_buffer))
661 g.debug_bytes = 512;
662
663 g.print_bytes = read(print_fd, print_buffer, g.debug_bytes);
664
665#else
09a101d6 666 g.print_bytes = read(print_fd, print_buffer, sizeof(print_buffer));
acb056cb 667#endif /* DEBUG_WRITES */
09a101d6 668
669 if (g.print_bytes < 0)
670 {
671 /*
672 * Read error - bail if we don't see EAGAIN or EINTR...
673 */
674
536bc2c6 675 if (errno != EAGAIN && errno != EINTR)
09a101d6 676 {
0837b7e8
MS
677 _cupsLangPrintFilter(stderr, "ERROR",
678 _("Unable to read print data."));
005dd1eb 679 perror("DEBUG: read");
ef55b745 680 registry_close();
f11a948a 681 return (CUPS_BACKEND_FAILED);
09a101d6 682 }
683
684 g.print_bytes = 0;
f7deaa1a 685 }
09a101d6 686 else if (g.print_bytes == 0)
687 {
688 /*
689 * End of file, break out of the loop...
690 */
f7deaa1a 691
e53920b9 692 break;
ef416fc2 693 }
694
09a101d6 695 print_ptr = print_buffer;
696
697 fprintf(stderr, "DEBUG: Read %d bytes of print data...\n",
698 (int)g.print_bytes);
e53920b9 699 }
ef416fc2 700
09a101d6 701 if (g.print_bytes)
702 {
1a18c85c 703 bytes = (UInt32)g.print_bytes;
178cb736 704 iostatus = (*g.classdriver)->WritePipe(g.classdriver, (UInt8*)print_ptr, &bytes, 0);
f7deaa1a 705
09a101d6 706 /*
58dc1933 707 * Ignore timeout errors, but retain the number of bytes written to
5a9febac 708 * avoid sending duplicate data...
09a101d6 709 */
e53920b9 710
178cb736 711 if (iostatus == kIOUSBTransactionTimeout)
b0f6947b 712 {
4d301e69 713 fputs("DEBUG: Got USB transaction timeout during write\n", stderr);
178cb736 714 iostatus = 0;
b0f6947b 715 }
ef416fc2 716
178cb736 717 /*
acb056cb 718 * If we've stalled, retry the write...
178cb736
MS
719 */
720
b0f6947b
MS
721 else if (iostatus == kIOUSBPipeStalled)
722 {
4d301e69 723 fputs("DEBUG: Got USB pipe stalled during write\n", stderr);
b0f6947b 724
1a18c85c 725 bytes = (UInt32)g.print_bytes;
acb056cb 726 iostatus = (*g.classdriver)->WritePipe(g.classdriver, (UInt8*)print_ptr, &bytes, 0);
b0f6947b 727 }
178cb736
MS
728
729 /*
acb056cb 730 * Retry a write after an aborted write since we probably just got
5a9febac 731 * SIGTERM...
178cb736
MS
732 */
733
b0f6947b 734 else if (iostatus == kIOReturnAborted)
178cb736 735 {
3fb9c47e 736 fputs("DEBUG: Got USB return aborted during write\n", stderr);
b0f6947b
MS
737
738 IOReturn err = (*g.classdriver)->Abort(g.classdriver);
739 fprintf(stderr, "DEBUG: USB class driver Abort returned %x\n", err);
740
acb056cb
MS
741#if DEBUG_WRITES
742 sleep(5);
743#endif /* DEBUG_WRITES */
b0f6947b 744
1a18c85c 745 bytes = (UInt32)g.print_bytes;
acb056cb 746 iostatus = (*g.classdriver)->WritePipe(g.classdriver, (UInt8*)print_ptr, &bytes, 0);
b0f6947b 747 }
178cb736 748
82f97232 749 if (iostatus)
09a101d6 750 {
751 /*
752 * Write error - bail if we don't see an error we can retry...
753 */
84315f46 754
0837b7e8
MS
755 _cupsLangPrintFilter(stderr, "ERROR",
756 _("Unable to send data to printer."));
178cb736
MS
757 fprintf(stderr, "DEBUG: USB class driver WritePipe returned %x\n",
758 iostatus);
b0f6947b
MS
759
760 IOReturn err = (*g.classdriver)->Abort(g.classdriver);
178cb736
MS
761 fprintf(stderr, "DEBUG: USB class driver Abort returned %x\n",
762 err);
b0f6947b 763
18ecb428 764 status = CUPS_BACKEND_FAILED;
bc44d920 765 break;
09a101d6 766 }
b0f6947b
MS
767 else if (bytes > 0)
768 {
769 fprintf(stderr, "DEBUG: Wrote %d bytes of print data...\n", (int)bytes);
09a101d6 770
b0f6947b
MS
771 g.print_bytes -= bytes;
772 print_ptr += bytes;
773 total_bytes += bytes;
774 }
f7deaa1a 775 }
09a101d6 776
777 if (print_fd != 0 && status == noErr)
778 fprintf(stderr, "DEBUG: Sending print file, %lld bytes...\n",
779 (off_t)total_bytes);
f7deaa1a 780 }
f7deaa1a 781 }
782
09a101d6 783 fprintf(stderr, "DEBUG: Sent %lld bytes...\n", (off_t)total_bytes);
1a18c85c 784 fputs("STATE: +cups-waiting-for-job-completed\n", stderr);
f7deaa1a 785
7cf5915e 786 /*
a4845881 787 * Signal the side channel thread to exit...
7cf5915e
MS
788 */
789
790 if (have_sidechannel)
791 {
792 close(CUPS_SC_FD);
793 pthread_mutex_lock(&g.readwrite_lock_mutex);
794 g.readwrite_lock = 0;
795 pthread_cond_signal(&g.readwrite_lock_cond);
796 pthread_mutex_unlock(&g.readwrite_lock_mutex);
797
798 g.sidechannel_thread_stop = 1;
799 pthread_mutex_lock(&g.sidechannel_thread_mutex);
84315f46 800
7cf5915e
MS
801 if (!g.sidechannel_thread_done)
802 {
84315f46
MS
803 gettimeofday(&tv, NULL);
804 cond_timeout.tv_sec = tv.tv_sec + WAIT_SIDE_DELAY;
805 cond_timeout.tv_nsec = tv.tv_usec * 1000;
7cf5915e 806
84315f46
MS
807 while (!g.sidechannel_thread_done)
808 {
809 if (pthread_cond_timedwait(&g.sidechannel_thread_cond,
810 &g.sidechannel_thread_mutex,
811 &cond_timeout) != 0)
812 break;
813 }
7cf5915e 814 }
84315f46 815
7cf5915e 816 pthread_mutex_unlock(&g.sidechannel_thread_mutex);
7cf5915e
MS
817 }
818
7cf5915e 819 /*
a4845881 820 * Signal the read thread to exit then wait 7 seconds for it to complete...
7cf5915e
MS
821 */
822
823 g.read_thread_stop = 1;
824
7cf5915e
MS
825 pthread_mutex_lock(&g.read_thread_mutex);
826
827 if (!g.read_thread_done)
828 {
a4845881
MS
829 fputs("DEBUG: Waiting for read thread to exit...\n", stderr);
830
84315f46
MS
831 gettimeofday(&tv, NULL);
832 cond_timeout.tv_sec = tv.tv_sec + WAIT_EOF_DELAY;
833 cond_timeout.tv_nsec = tv.tv_usec * 1000;
7cf5915e 834
84315f46
MS
835 while (!g.read_thread_done)
836 {
837 if (pthread_cond_timedwait(&g.read_thread_cond, &g.read_thread_mutex,
838 &cond_timeout) != 0)
839 break;
840 }
841
a4845881
MS
842 /*
843 * If it didn't exit abort the pending read and wait an additional second...
844 */
f3c17241 845
84315f46 846 if (!g.read_thread_done)
7cf5915e 847 {
f3c17241 848 fputs("DEBUG: Read thread still active, aborting the pending read...\n",
a4845881 849 stderr);
7cf5915e
MS
850
851 g.wait_eof = 0;
a4845881
MS
852
853 (*g.classdriver)->Abort(g.classdriver);
854
855 gettimeofday(&tv, NULL);
856 cond_timeout.tv_sec = tv.tv_sec + 1;
857 cond_timeout.tv_nsec = tv.tv_usec * 1000;
f3c17241 858
a4845881
MS
859 while (!g.read_thread_done)
860 {
861 if (pthread_cond_timedwait(&g.read_thread_cond, &g.read_thread_mutex,
862 &cond_timeout) != 0)
863 break;
864 }
7cf5915e
MS
865 }
866 }
84315f46 867
7cf5915e
MS
868 pthread_mutex_unlock(&g.read_thread_mutex);
869
09a101d6 870 /*
871 * Close the connection and input file and general clean up...
872 */
f7deaa1a 873
09a101d6 874 registry_close();
f7deaa1a 875
09a101d6 876 if (print_fd != STDIN_FILENO)
877 close(print_fd);
f7deaa1a 878
09a101d6 879 if (g.make != NULL)
880 CFRelease(g.make);
e53920b9 881
09a101d6 882 if (g.model != NULL)
883 CFRelease(g.model);
e53920b9 884
09a101d6 885 if (g.serial != NULL)
886 CFRelease(g.serial);
e53920b9 887
09a101d6 888 if (g.printer_obj != 0x0)
889 IOObjectRelease(g.printer_obj);
e53920b9 890
891 return status;
ef416fc2 892}
893
09a101d6 894
895/*
896 * 'read_thread()' - Thread to read the backchannel data on.
897 */
898
899static void *read_thread(void *reference)
900{
901 UInt8 readbuffer[512];
902 UInt32 rbytes;
903 kern_return_t readstatus;
904 struct mach_timebase_info timeBaseInfo;
905 uint64_t start,
906 delay;
907
321d8d57
MS
908
909 (void)reference;
910
09a101d6 911 /* Calculate what 250 milliSeconds are in mach absolute time...
912 */
913 mach_timebase_info(&timeBaseInfo);
914 delay = ((uint64_t)250000000 * (uint64_t)timeBaseInfo.denom) / (uint64_t)timeBaseInfo.numer;
915
916 do
917 {
918 /*
919 * Remember when we started so we can throttle the loop after the read call...
920 */
921
922 start = mach_absolute_time();
923
924 rbytes = sizeof(readbuffer);
925 readstatus = (*g.classdriver)->ReadPipe(g.classdriver, readbuffer, &rbytes);
926 if (readstatus == kIOReturnSuccess && rbytes > 0)
927 {
b0f6947b
MS
928 fprintf(stderr, "DEBUG: Read %d bytes of back-channel data...\n",
929 (int)rbytes);
09a101d6 930 cupsBackChannelWrite((char*)readbuffer, rbytes, 1.0);
931
932 /* cntrl-d is echoed by the printer.
933 * NOTES:
934 * Xerox Phaser 6250D doesn't echo the cntrl-d.
935 * Xerox Phaser 6250D doesn't always send the product query.
936 */
937 if (g.wait_eof && readbuffer[rbytes-1] == 0x4)
938 break;
939
940#ifdef PARSE_PS_ERRORS
941 parse_pserror(readbuffer, rbytes);
942#endif
943 }
b0f6947b 944 else if (readstatus == kIOUSBTransactionTimeout)
3fb9c47e 945 fputs("DEBUG: Got USB transaction timeout during read\n", stderr);
b0f6947b 946 else if (readstatus == kIOUSBPipeStalled)
4d301e69 947 fputs("DEBUG: Got USB pipe stalled during read\n", stderr);
b0f6947b 948 else if (readstatus == kIOReturnAborted)
3fb9c47e 949 fputs("DEBUG: Got USB return aborted during read\n", stderr);
09a101d6 950
951 /*
952 * Make sure this loop executes no more than once every 250 miliseconds...
953 */
954
955 if ((readstatus != kIOReturnSuccess || rbytes == 0) && (g.wait_eof || !g.read_thread_stop))
956 mach_wait_until(start + delay);
957
958 } while (g.wait_eof || !g.read_thread_stop); /* Abort from main thread tests error here */
959
960 /*
961 * Let the main thread know that we have completed the read thread...
962 */
963
964 pthread_mutex_lock(&g.read_thread_mutex);
965 g.read_thread_done = 1;
966 pthread_cond_signal(&g.read_thread_cond);
967 pthread_mutex_unlock(&g.read_thread_mutex);
968
969 return NULL;
970}
971
972
973/*
974 * 'sidechannel_thread()' - Handle side-channel requests.
975 */
976
977static void*
978sidechannel_thread(void *reference)
979{
980 cups_sc_command_t command; /* Request command */
981 cups_sc_status_t status; /* Request/response status */
982 char data[2048]; /* Request/response data */
983 int datalen; /* Request/response data size */
984
bc44d920 985
321d8d57
MS
986 (void)reference;
987
bc44d920 988 do
09a101d6 989 {
990 datalen = sizeof(data);
991
992 if (cupsSideChannelRead(&command, &status, data, &datalen, 1.0))
ef55b745
MS
993 {
994 if (status == CUPS_SC_STATUS_TIMEOUT)
995 continue;
996 else
997 break;
998 }
09a101d6 999
1000 switch (command)
1001 {
1002 case CUPS_SC_CMD_SOFT_RESET: /* Do a soft reset */
b0f6947b
MS
1003 fputs("DEBUG: CUPS_SC_CMD_SOFT_RESET received from driver...\n",
1004 stderr);
1005
db1f069b
MS
1006 if ((*g.classdriver)->SoftReset != NULL)
1007 {
1008 soft_reset();
1009 cupsSideChannelWrite(command, CUPS_SC_STATUS_OK, NULL, 0, 1.0);
b0f6947b
MS
1010 fputs("DEBUG: Returning status CUPS_STATUS_OK with no bytes...\n",
1011 stderr);
db1f069b
MS
1012 }
1013 else
1014 {
1015 cupsSideChannelWrite(command, CUPS_SC_STATUS_NOT_IMPLEMENTED,
1016 NULL, 0, 1.0);
b0f6947b
MS
1017 fputs("DEBUG: Returning status CUPS_STATUS_NOT_IMPLEMENTED with "
1018 "no bytes...\n", stderr);
db1f069b 1019 }
09a101d6 1020 break;
1021
1022 case CUPS_SC_CMD_DRAIN_OUTPUT: /* Drain all pending output */
b0f6947b
MS
1023 fputs("DEBUG: CUPS_SC_CMD_DRAIN_OUTPUT received from driver...\n",
1024 stderr);
1025
09a101d6 1026 g.drain_output = 1;
1027 break;
1028
1029 case CUPS_SC_CMD_GET_BIDI: /* Is the connection bidirectional? */
b0f6947b
MS
1030 fputs("DEBUG: CUPS_SC_CMD_GET_BIDI received from driver...\n",
1031 stderr);
1032
1a18c85c 1033 data[0] = (char)g.bidi_flag;
09a101d6 1034 cupsSideChannelWrite(command, CUPS_SC_STATUS_OK, data, 1, 1.0);
b0f6947b
MS
1035
1036 fprintf(stderr,
1037 "DEBUG: Returned CUPS_SC_STATUS_OK with 1 byte (%02X)...\n",
1038 data[0]);
09a101d6 1039 break;
1040
1041 case CUPS_SC_CMD_GET_DEVICE_ID: /* Return IEEE-1284 device ID */
b0f6947b
MS
1042 fputs("DEBUG: CUPS_SC_CMD_GET_DEVICE_ID received from driver...\n",
1043 stderr);
1044
09a101d6 1045 datalen = sizeof(data);
1046 get_device_id(&status, data, &datalen);
1047 cupsSideChannelWrite(command, CUPS_SC_STATUS_OK, data, datalen, 1.0);
b0f6947b 1048
1a18c85c 1049 if ((size_t)datalen < sizeof(data))
b0f6947b
MS
1050 data[datalen] = '\0';
1051 else
1052 data[sizeof(data) - 1] = '\0';
1053
1054 fprintf(stderr,
1055 "DEBUG: Returning CUPS_SC_STATUS_OK with %d bytes (%s)...\n",
1056 datalen, data);
09a101d6 1057 break;
1058
1059 case CUPS_SC_CMD_GET_STATE: /* Return device state */
b0f6947b
MS
1060 fputs("DEBUG: CUPS_SC_CMD_GET_STATE received from driver...\n",
1061 stderr);
1062
09a101d6 1063 data[0] = CUPS_SC_STATE_ONLINE;
1064 cupsSideChannelWrite(command, CUPS_SC_STATUS_OK, data, 1, 1.0);
b0f6947b
MS
1065
1066 fprintf(stderr,
1067 "DEBUG: Returned CUPS_SC_STATUS_OK with 1 byte (%02X)...\n",
1068 data[0]);
09a101d6 1069 break;
1070
1071 default:
b0f6947b
MS
1072 fprintf(stderr, "DEBUG: Unknown side-channel command (%d) received "
1073 "from driver...\n", command);
1074
09a101d6 1075 cupsSideChannelWrite(command, CUPS_SC_STATUS_NOT_IMPLEMENTED,
1076 NULL, 0, 1.0);
b0f6947b
MS
1077
1078 fputs("DEBUG: Returned CUPS_SC_STATUS_NOT_IMPLEMENTED with no bytes...\n",
1079 stderr);
09a101d6 1080 break;
1081 }
1082 }
7cf5915e
MS
1083 while (!g.sidechannel_thread_stop);
1084
1085 pthread_mutex_lock(&g.sidechannel_thread_mutex);
1086 g.sidechannel_thread_done = 1;
1087 pthread_cond_signal(&g.sidechannel_thread_cond);
1088 pthread_mutex_unlock(&g.sidechannel_thread_mutex);
bc44d920 1089
09a101d6 1090 return NULL;
1091}
1092
1093
e53920b9 1094#pragma mark -
ef416fc2 1095/*
09a101d6 1096 * 'iterate_printers()' - Iterate over all the printers.
1097 */
1098
a215cf84 1099static void iterate_printers(iterator_callback_t callBack, void *userdata)
09a101d6 1100{
a215cf84
MS
1101 Iterating = 1;
1102
1103 mach_port_t masterPort = 0x0;
1104 kern_return_t kr = IOMasterPort (bootstrap_port, &masterPort);
1105
1106 if (kr == kIOReturnSuccess && masterPort != 0x0)
09a101d6 1107 {
a215cf84
MS
1108 iterator_reference_t reference = { callBack, userdata, true };
1109
1110 IONotificationPortRef addNotification = IONotificationPortCreate(masterPort);
1111 io_iterator_t addIterator = IO_OBJECT_NULL;
1112
1113 kr = IOServiceAddMatchingNotification(addNotification, kIOFirstMatchNotification, IOServiceMatching(kIOUSBDeviceClassName),
1114 &device_added, &reference, &addIterator);
1115 if (kr == kIOReturnSuccess && addIterator != IO_OBJECT_NULL)
1116 {
1117 device_added(&reference, addIterator);
1118 if (reference.keepRunning)
1119 {
1120 CFRunLoopAddSource(CFRunLoopGetCurrent(), IONotificationPortGetRunLoopSource(addNotification), kCFRunLoopDefaultMode);
1121 CFRunLoopRun();
1122 }
1123 IOObjectRelease(addIterator);
1124 }
1125 mach_port_deallocate(mach_task_self(), masterPort);
09a101d6 1126 }
a215cf84
MS
1127
1128 Iterating = 0;
09a101d6 1129}
1130
1131
1132/*
1133 * 'device_added()' - Device added notifier.
e53920b9 1134 */
a215cf84 1135#define IsPrintingInterface(c,s,p) ((c) == kUSBPrintingInterfaceClass && (s) == kUSBPrintingSubclass && (p) != kUSBPrintingProtocolIPP)
e53920b9 1136
a215cf84 1137static void device_added(void *userdata, io_iterator_t iterator)
09a101d6 1138{
a215cf84
MS
1139 iterator_reference_t *reference = userdata;
1140 io_service_t device;
1141
1142 while (reference->keepRunning && (device = IOIteratorNext(iterator)) != 0x0)
1143 {
1144 UInt32 locationID = 0;
1145 IOUSBDeviceInterface **devIntf = NULL;
1146 io_iterator_t intfIterator = IO_OBJECT_NULL;
1147 io_object_t intf = IO_OBJECT_NULL;
1148
1149 devIntf = usb_device_interface_for_device(device);
1150 if (devIntf == NULL)
1151 goto device_added_done;
1152
1153 UInt16 vendorUniqueID;
1154 if ((*devIntf)->GetDeviceVendor(devIntf, &vendorUniqueID) != kIOReturnSuccess || vendorUniqueID == kAppleVendorID || vendorUniqueID == 0x0A5C)
1155 goto device_added_done;
1156
1157 if ((*devIntf)->GetLocationID(devIntf, &locationID) != kIOReturnSuccess)
1158 goto device_added_done;
1159
1160 IOUSBFindInterfaceRequest req = { kIOUSBFindInterfaceDontCare, kIOUSBFindInterfaceDontCare, kIOUSBFindInterfaceDontCare, kIOUSBFindInterfaceDontCare };
1161 if ((*devIntf)->CreateInterfaceIterator(devIntf, &req, &intfIterator) != kIOReturnSuccess)
1162 goto device_added_done;
1163
1164 while (reference->keepRunning && (intf = IOIteratorNext(intfIterator)))
1165 {
1166 IOUSBInterfaceInterface220 **intf220 = usb_interface220_for_service(intf);
1167 if (intf220 != NULL)
1168 {
1169 UInt8 intfClass = 0, intfSubclass = 0, intfProtocol = 0, intfNumber = 0;
1170
1171 (*intf220)->GetInterfaceClass(intf220, &intfClass);
1172 (*intf220)->GetInterfaceSubClass(intf220, &intfSubclass);
1173 (*intf220)->GetInterfaceProtocol(intf220, &intfProtocol);
1174 (*intf220)->GetInterfaceNumber(intf220, &intfNumber);
1175
1176 if (IsPrintingInterface(intfClass, intfSubclass, intfProtocol))
1177 {
1178 CFStringRef deviceIDString = printer_interface_deviceid(intf220, 0);
1179 if (deviceIDString != NULL)
1180 {
1181 reference->keepRunning = reference->callback(userdata, intf, deviceIDString, locationID, intfNumber, 0);
1182 CFRelease(deviceIDString);
1183 }
1184 }
1185
1186 IOUSBInterfaceDescriptor *intfDesc = nil;
1187 while (reference->keepRunning && (intfDesc = (IOUSBInterfaceDescriptor *)(*intf220)->FindNextAssociatedDescriptor(intf220, intfDesc, kUSBInterfaceDesc)))
1188 {
1189 intfClass = intfDesc->bInterfaceClass;
1190 intfSubclass = intfDesc->bInterfaceSubClass;
1191 intfProtocol = intfDesc->bInterfaceProtocol;
1192
1193 if ((IsPrintingInterface(intfClass, intfSubclass, intfProtocol)))
1194 {
1195 CFStringRef deviceIDString = printer_interface_deviceid(intf220, intfDesc->bAlternateSetting);
1196 if (deviceIDString != NULL)
1197 {
1198 reference->keepRunning = reference->callback(userdata, intf, deviceIDString, locationID, intfNumber, intfDesc->bAlternateSetting);
1199 CFRelease(deviceIDString);
1200 }
1201 }
1202 }
1203 (*intf220)->Release(intf220);
1204 }
1205 }
09a101d6 1206
a215cf84
MS
1207 device_added_done:
1208 if (devIntf != NULL) (*devIntf)->Release(devIntf);
1209 if (intfIterator != IO_OBJECT_NULL) IOObjectRelease(intfIterator);
09a101d6 1210
a215cf84
MS
1211 IOObjectRelease(device);
1212 }
1213
1214 /* One last call to the call back now that we are not longer have printers left to iterate...
1215 */
1216 if (reference->keepRunning && reference->callback)
1217 reference->keepRunning = reference->callback(reference->userdata, IO_OBJECT_NULL, NULL, 0, 0, 0);
1218
1219 if (!reference->keepRunning)
1220 CFRunLoopStop(CFRunLoopGetCurrent());
09a101d6 1221}
1222
09a101d6 1223/*
1224 * 'list_device_cb()' - list_device iterator callback.
1225 */
1226
a215cf84 1227static Boolean list_device_cb(void *refcon, io_service_t obj, CFStringRef deviceIDString, UInt32 deviceLocation, UInt8 interfaceNum, UInt8 alternateSetting)
ef416fc2 1228{
a215cf84
MS
1229 (void)interfaceNum;
1230 (void)alternateSetting;
321d8d57 1231
a215cf84 1232 if (obj != IO_OBJECT_NULL)
09a101d6 1233 {
a215cf84
MS
1234 CFStringRef make = NULL;
1235 CFStringRef model = NULL;
1236 CFStringRef serial = NULL;
1237
1238 char uristr[1024], makestr[1024], modelstr[1024], serialstr[1024];
1239 char optionsstr[1024], idstr[1024], make_modelstr[1024];
1240
1241 CFStringGetCString(deviceIDString, idstr, sizeof(idstr), kCFStringEncodingUTF8);
1242 backendGetMakeModel(idstr, make_modelstr, sizeof(make_modelstr));
1243
1244 modelstr[0] = '/';
1245
1246 if (make == NULL || !CFStringGetCString(make, makestr, sizeof(makestr), kCFStringEncodingUTF8))
1247 strlcpy(makestr, "Unknown", sizeof(makestr));
1248
1249 if (model == NULL || !CFStringGetCString(model, &modelstr[1], sizeof(modelstr)-1, kCFStringEncodingUTF8))
1250 strlcpy(modelstr + 1, "Printer", sizeof(modelstr) - 1);
1251
1252 optionsstr[0] = '\0';
1253 if (serial != NULL && CFStringGetCString(serial, serialstr, sizeof(serialstr), kCFStringEncodingUTF8))
1254 snprintf(optionsstr, sizeof(optionsstr), "?serial=%s", serialstr);
1255 else if (deviceLocation != 0)
1256 snprintf(optionsstr, sizeof(optionsstr), "?location=%x", (unsigned)deviceLocation);
1257
1258 httpAssembleURI(HTTP_URI_CODING_ALL, uristr, sizeof(uristr), "usb", NULL, makestr, 0, modelstr);
1259 strlcat(uristr, optionsstr, sizeof(uristr));
1260
1261 cupsBackendReport("direct", uristr, make_modelstr, make_modelstr, idstr,
1262 NULL);
ef416fc2 1263 }
a215cf84
MS
1264
1265 return obj != IO_OBJECT_NULL;
ef416fc2 1266}
1267
e53920b9 1268/*
09a101d6 1269 * 'find_device_cb()' - print_device iterator callback.
e53920b9 1270 */
a215cf84 1271static Boolean find_device_cb(void *refcon, io_service_t obj, CFStringRef deviceIDString, UInt32 deviceLocation, UInt8 interfaceNum, UInt8 alternateSetting)
e53920b9 1272{
a215cf84
MS
1273 Boolean keepLooking = true;
1274
1275 if (obj != IO_OBJECT_NULL)
09a101d6 1276 {
a215cf84
MS
1277 CFStringRef make = deviceIDCopyManufacturer(deviceIDString);
1278 CFStringRef model = deviceIDCopyModel(deviceIDString);
1279 CFStringRef serial = deviceIDCopySerialNumber(deviceIDString);
1280
1281 if (make && CFStringCompare(make, g.make, kCFCompareCaseInsensitive) == kCFCompareEqualTo)
1282 {
1283 if (model && CFStringCompare(model, g.model, kCFCompareCaseInsensitive) == kCFCompareEqualTo)
1284 {
1285 if (g.serial != NULL && CFStringGetLength(g.serial) > 0)
1286 {
1287 if (serial != NULL && CFStringCompare(serial, g.serial, kCFCompareCaseInsensitive) == kCFCompareEqualTo)
1288 {
1289 IOObjectRetain(obj);
1290 g.printer_obj = obj;
1291 g.alternateSetting = alternateSetting;
1292 keepLooking = false;
1293 }
1294 }
1295 else
1296 {
1297 if (g.printer_obj != 0)
1298 IOObjectRelease(g.printer_obj);
1299
1300 g.alternateSetting = alternateSetting;
1301 g.printer_obj = obj;
1302 IOObjectRetain(obj);
1303
1304 if (g.location == 0 || g.location == deviceLocation)
1305 keepLooking = false;
1306 }
1307
1308 if ( !keepLooking )
1309 g.interfaceNum = interfaceNum;
1310 }
1311 }
1312
1313 if (make) CFRelease(make);
1314 if (model) CFRelease(model);
1315 if (serial) CFRelease(serial);
ef416fc2 1316 }
a215cf84 1317 else
09a101d6 1318 {
a215cf84
MS
1319 keepLooking = (g.printer_obj == 0);
1320 if (obj == IO_OBJECT_NULL && keepLooking)
1321 {
1322 CFRunLoopTimerContext context = { 0, refcon, NULL, NULL, NULL };
1323 CFRunLoopTimerRef timer = CFRunLoopTimerCreate(NULL, CFAbsoluteTimeGetCurrent() + 1.0, 10, 0x0, 0x0, status_timer_cb, &context);
1324 if (timer != NULL)
1325 {
1326 CFRunLoopAddTimer(CFRunLoopGetCurrent(), timer, kCFRunLoopDefaultMode);
1327 g.status_timer = timer;
1328 }
1329 }
7594b224 1330 }
a215cf84
MS
1331
1332 if (!keepLooking && g.status_timer != NULL)
1333 {
1334 fputs("STATE: -offline-report\n", stderr);
1335 _cupsLangPrintFilter(stderr, "INFO", _("The printer is now online."));
1336 CFRunLoopRemoveTimer(CFRunLoopGetCurrent(), g.status_timer, kCFRunLoopDefaultMode);
1337 CFRelease(g.status_timer);
1338 g.status_timer = NULL;
1339 }
1340
1341 return keepLooking;
1342}
09a101d6 1343
a215cf84
MS
1344static CFStringRef deviceIDCopySerialNumber(CFStringRef deviceID)
1345{
1346 CFStringRef serialKeys[] = { CFSTR("SN:"), CFSTR("SERN:"), NULL };
1347
1348 return copy_value_for_key(deviceID, serialKeys);
1349}
ef416fc2 1350
a215cf84
MS
1351static CFStringRef deviceIDCopyModel(CFStringRef deviceID)
1352{
1353 CFStringRef modelKeys[] = { CFSTR("MDL:"), CFSTR("MODEL:"), NULL };
1354 return copy_value_for_key(deviceID, modelKeys);
ef416fc2 1355}
1356
a215cf84
MS
1357static CFStringRef deviceIDCopyManufacturer(CFStringRef deviceID)
1358{
1359 CFStringRef makeKeys[] = { CFSTR("MFG:"), CFSTR("MANUFACTURER:"), NULL };
1360 return copy_value_for_key(deviceID, makeKeys);
1361}
ef416fc2 1362
e53920b9 1363/*
09a101d6 1364 * 'status_timer_cb()' - Status timer callback.
ef416fc2 1365 */
e53920b9 1366
09a101d6 1367static void status_timer_cb(CFRunLoopTimerRef timer,
1368 void *info)
ef416fc2 1369{
321d8d57
MS
1370 (void)timer;
1371 (void)info;
1372
c5571a1d 1373 fputs("STATE: +offline-report\n", stderr);
f3c17241 1374 _cupsLangPrintFilter(stderr, "INFO", _("The printer is offline."));
0a682745
MS
1375
1376 if (getenv("CLASS") != NULL)
1377 {
1378 /*
1379 * If the CLASS environment variable is set, the job was submitted
1380 * to a class and not to a specific queue. In this case, we want
1381 * to abort immediately so that the job can be requeued on the next
1382 * available printer in the class.
1383 *
1384 * Sleep 5 seconds to keep the job from requeuing too rapidly...
1385 */
1386
1387 sleep(5);
1388
1389 exit(CUPS_BACKEND_FAILED);
1390 }
ef416fc2 1391}
1392
ef416fc2 1393
e53920b9 1394#pragma mark -
1395/*
1396 * 'load_classdriver()' - Load a classdriver.
1397 */
1398
09a101d6 1399static kern_return_t load_classdriver(CFStringRef driverPath,
321d8d57 1400 printer_interface_t interface,
09a101d6 1401 classdriver_t ***printerDriver)
e53920b9 1402{
bf3816c7
MS
1403 kern_return_t kr = kUSBPrinterClassDeviceNotOpen;
1404 classdriver_t **driver = NULL;
1405 CFStringRef bundle = driverPath ? driverPath : kUSBGenericTOPrinterClassDriver;
1406 char bundlestr[1024]; /* Bundle path */
bf3816c7
MS
1407 CFURLRef url; /* URL for driver */
1408 CFPlugInRef plugin = NULL; /* Plug-in address */
e53920b9 1409
bf3816c7
MS
1410
1411 CFStringGetCString(bundle, bundlestr, sizeof(bundlestr), kCFStringEncodingUTF8);
1412
1413 /*
1414 * Validate permissions for the class driver...
1415 */
1416
22c9029b
MS
1417 _cups_fc_result_t result = _cupsFileCheck(bundlestr,
1418 _CUPS_FILE_CHECK_DIRECTORY, 1,
0fa6c7fa 1419 Iterating ? NULL : _cupsFileCheckFilter, NULL);
22c9029b
MS
1420
1421 if (result && driverPath)
321d8d57 1422 return (load_classdriver(NULL, interface, printerDriver));
22c9029b
MS
1423 else if (result)
1424 return (kr);
bf3816c7
MS
1425
1426 /*
1427 * Try loading the class driver...
1428 */
1429
1430 url = CFURLCreateWithFileSystemPath(NULL, bundle, kCFURLPOSIXPathStyle, true);
e53920b9 1431
bf3816c7
MS
1432 if (url)
1433 {
1434 plugin = CFPlugInCreate(NULL, url);
1435 CFRelease(url);
1436 }
1437 else
1438 plugin = NULL;
e53920b9 1439
bf3816c7
MS
1440 if (plugin)
1441 {
1442 CFArrayRef factories = CFPlugInFindFactoriesForPlugInTypeInPlugIn(kUSBPrinterClassTypeID, plugin);
1443 if (factories != NULL && CFArrayGetCount(factories) > 0)
09a101d6 1444 {
bf3816c7
MS
1445 CFUUIDRef factoryID = CFArrayGetValueAtIndex(factories, 0);
1446 IUnknownVTbl **iunknown = CFPlugInInstanceCreate(NULL, factoryID, kUSBPrinterClassTypeID);
1447 if (iunknown != NULL)
09a101d6 1448 {
bf3816c7
MS
1449 kr = (*iunknown)->QueryInterface(iunknown, CFUUIDGetUUIDBytes(kUSBPrinterClassInterfaceID), (LPVOID *)&driver);
1450 if (kr == kIOReturnSuccess && driver != NULL)
09a101d6 1451 {
bf3816c7
MS
1452 classdriver_t **genericDriver = NULL;
1453 if (driverPath != NULL && CFStringCompare(driverPath, kUSBGenericTOPrinterClassDriver, 0) != kCFCompareEqualTo)
321d8d57 1454 kr = load_classdriver(NULL, interface, &genericDriver);
e53920b9 1455
bf3816c7
MS
1456 if (kr == kIOReturnSuccess)
1457 {
321d8d57 1458 (*driver)->interface = interface;
bf3816c7 1459 (*driver)->Initialize(driver, genericDriver);
e53920b9 1460
bf3816c7 1461 (*driver)->plugin = plugin;
321d8d57 1462 (*driver)->interface = interface;
bf3816c7 1463 *printerDriver = driver;
e53920b9 1464 }
e53920b9 1465 }
bf3816c7 1466 (*iunknown)->Release(iunknown);
e53920b9 1467 }
bf3816c7 1468 CFRelease(factories);
ef416fc2 1469 }
e53920b9 1470 }
1471
c0e1af83 1472 fprintf(stderr, "DEBUG: load_classdriver(%s) (kr:0x%08x)\n", bundlestr, (int)kr);
ef416fc2 1473
bf3816c7 1474 return (kr);
ef416fc2 1475}
1476
1477
e53920b9 1478/*
1479 * 'unload_classdriver()' - Unload a classdriver.
1480 */
ef416fc2 1481
09a101d6 1482static kern_return_t unload_classdriver(classdriver_t ***classdriver)
e53920b9 1483{
09a101d6 1484 if (*classdriver != NULL)
1485 {
1486 (**classdriver)->Release(*classdriver);
1487 *classdriver = NULL;
e53920b9 1488 }
ef416fc2 1489
e53920b9 1490 return kIOReturnSuccess;
1491}
ef416fc2 1492
ef416fc2 1493
e53920b9 1494/*
09a101d6 1495 * 'load_printerdriver()' - Load vendor's classdriver.
411affcf 1496 *
1497 * If driverBundlePath is not NULL on return it is the callers responsbility to release it!
e53920b9 1498 */
ef416fc2 1499
09a101d6 1500static kern_return_t load_printerdriver(CFStringRef *driverBundlePath)
ef416fc2 1501{
7594b224 1502 IOCFPlugInInterface **iodev = NULL;
1503 SInt32 score;
1504 kern_return_t kr;
321d8d57 1505 printer_interface_t interface;
7594b224 1506 HRESULT res;
1507
09a101d6 1508 kr = IOCreatePlugInInterfaceForService(g.printer_obj, kIOUSBInterfaceUserClientTypeID, kIOCFPlugInInterfaceID, &iodev, &score);
7594b224 1509 if (kr == kIOReturnSuccess)
1510 {
321d8d57 1511 if ((res = (*iodev)->QueryInterface(iodev, USB_INTERFACE_KIND, (LPVOID *) &interface)) == noErr)
7594b224 1512 {
09a101d6 1513 *driverBundlePath = IORegistryEntryCreateCFProperty(g.printer_obj, kUSBClassDriverProperty, NULL, kNilOptions);
e53920b9 1514
321d8d57 1515 kr = load_classdriver(*driverBundlePath, interface, &g.classdriver);
ef416fc2 1516
e53920b9 1517 if (kr != kIOReturnSuccess)
321d8d57 1518 (*interface)->Release(interface);
e53920b9 1519 }
1520 IODestroyPlugInInterface(iodev);
1521 }
1522 return kr;
ef416fc2 1523}
1524
a215cf84
MS
1525static IOUSBInterfaceInterface220 **usb_interface220_for_service(io_service_t usbClass)
1526{
1527 IOUSBInterfaceInterface220 ** intf = NULL;
1528 IOCFPlugInInterface **plugin = NULL;
1529 SInt32 score;
1530 int kr = IOCreatePlugInInterfaceForService(usbClass, kIOUSBInterfaceUserClientTypeID, kIOCFPlugInInterfaceID, &plugin, &score);
1531 if (kr == kIOReturnSuccess)
1532 {
1533 (*plugin)->QueryInterface(plugin, CFUUIDGetUUIDBytes(kIOUSBInterfaceInterfaceID220), (LPVOID *)&intf);
1534 IODestroyPlugInInterface(plugin);
1535 }
1536
1537 return intf;
1538}
1539
1540static IOUSBDeviceInterface **usb_device_interface_for_device(io_service_t usbDevice)
1541{
1542 IOUSBDeviceInterface ** intf = NULL;
1543 IOCFPlugInInterface **plugin = NULL;
1544 SInt32 score;
1545
1546 int kr = IOCreatePlugInInterfaceForService(usbDevice, kIOUSBDeviceUserClientTypeID, kIOCFPlugInInterfaceID, &plugin, &score);
1547 if (kr == kIOReturnSuccess)
1548 {
1549 (*plugin)->QueryInterface(plugin, CFUUIDGetUUIDBytes(kIOUSBDeviceInterfaceID), (LPVOID *)&intf);
1550 IODestroyPlugInInterface(plugin);
1551 }
1552
1553 return intf;
1554}
1555
1556
1557static CFStringRef printer_interface_deviceid(IOUSBInterfaceInterface220 **printer, UInt8 alternateSetting)
1558{
1559 // I have tried to make this function as neat as I can, but the possibility of needing to resend
1560 // a request to get the entire string makes it hideous...
1561 //
1562 // We package the job of sending a request up into the block (^sendRequest), which takes the size
1563 // it should allocate for the message buffer. It frees the current buffer if one is set and
1564 // allocates one of the specified size, then performs the request. We can then easily retry by
1565 // calling the block again if we fail to get the whole string the first time around.
1566
1567 #define kUSBPrintClassGetDeviceID 0
1568 #define kDefaultNoDataTimeout 5000L
1569 #define pack_device_id_wIndex(intf, alt) ((UInt16)((((UInt16)(intf)) << 8) | ((UInt8)(alt))))
1570
1571 if (printer == nil)
1572 return nil;
1573
1574
1575 IOReturn err = kIOReturnError;
1576 UInt8 configurationIndex = 0;
1577 UInt8 interfaceNumber = 0;
1578 size_t bufferLength = 256;
1579 CFStringRef ret = NULL;
1580
1581 if ((*printer)->GetConfigurationValue( printer, &configurationIndex) == kIOReturnSuccess &&
1582 (*printer)->GetInterfaceNumber( printer, &interfaceNumber) == kIOReturnSuccess)
1583 {
1584 __block IOUSBDevRequestTO request;
1585 IOReturn (^sendRequest)(size_t) = ^ (size_t size)
1586 {
1587 if (request.pData)
1588 {
1589 free(request.pData);
1590 request.wLength = 0;
1591 request.pData = NULL;
1592 }
1593
1594 IOReturn err = kIOReturnError;
1595 char *buffer = malloc(size);
1596 if (buffer == NULL)
1597 return kIOReturnNoMemory;
1598
1599 request.wLength = HostToUSBWord(size);
1600 request.pData = buffer;
1601 err = (*printer)->ControlRequestTO(printer, (UInt8)0, &request);
1602 return err;
1603 };
1604
1605 /* This request takes the 0 based configuration index. IOKit returns a 1 based configuration index */
1606 configurationIndex -= 1;
1607
1608 bzero(&request, sizeof(request));
1609
1610 request.bmRequestType = USBmakebmRequestType(kUSBIn, kUSBClass, kUSBInterface);
1611 request.bRequest = kUSBPrintClassGetDeviceID;
1612 request.wValue = HostToUSBWord(configurationIndex);
1613 request.wIndex = HostToUSBWord(pack_device_id_wIndex(interfaceNumber, alternateSetting));
1614 request.noDataTimeout = kDefaultNoDataTimeout;
1615 request.completionTimeout = 0; // Copying behavior from Generic Class Driver
1616
1617 err = sendRequest(bufferLength);
1618
1619 if (err == kIOReturnSuccess && request.wLenDone > 1)
1620 {
1621 UInt16 actualLength = OSSwapBigToHostInt16(*((UInt16 *)request.pData));
1622
1623 if (actualLength > 2 && actualLength <= bufferLength - 2)
1624 {
1625 ret = CFStringCreateWithBytes(NULL, (const UInt8 *) &request.pData[2], actualLength - 2, kCFStringEncodingUTF8, false);
1626 }
1627 else {
1628 err = sendRequest(actualLength);
1629 if (err == kIOReturnSuccess && request.wLenDone > 0)
1630 {
1631 actualLength = OSSwapBigToHostInt16(*((UInt16 *)request.pData));
1632 ret = CFStringCreateWithBytes(NULL, (const UInt8 *) &request.pData[2], actualLength - 2, kCFStringEncodingUTF8, false);
1633 }
1634 }
1635 }
1636
1637 if (request.pData)
1638 free(request.pData);
1639 }
1640
1641 CFStringRef manufacturer = deviceIDCopyManufacturer(ret);
1642 CFStringRef model = deviceIDCopyManufacturer(ret);
1643 CFStringRef serial = deviceIDCopySerialNumber(ret);
1644
1645 if (manufacturer == NULL || serial == NULL || model == NULL)
1646 {
1647 IOUSBDevRequestTO request;
1648 IOUSBDeviceDescriptor desc;
1649
1650 bzero(&request, sizeof(request));
1651
1652 request.bmRequestType = USBmakebmRequestType( kUSBIn, kUSBStandard, kUSBDevice );
1653 request.bRequest = kUSBRqGetDescriptor;
1654 request.wValue = kUSBDeviceDesc << 8;
1655 request.wIndex = 0;
1656 request.wLength = sizeof(desc);
1657 request.pData = &desc;
1658 request.completionTimeout = 0;
1659 request.noDataTimeout = 60L;
1660
1661 err = (*printer)->ControlRequestTO(printer, 0, &request);
1662 if (err == kIOReturnSuccess)
1663 {
1664 CFMutableStringRef extras = CFStringCreateMutable(NULL, 0);
1665 if (manufacturer == NULL)
1666 {
1667 manufacturer = printer_interface_indexed_description(printer, desc.iManufacturer, kUSBLanguageEnglish);
1668 if (CFStringGetLength(manufacturer) > 0)
1669 CFStringAppendFormat(extras, NULL, CFSTR("MFG:%@;"), manufacturer);
1670 }
1671
1672 if (model == NULL)
1673 {
1674 model = printer_interface_indexed_description(printer, desc.iProduct, kUSBLanguageEnglish);
1675 if (CFStringGetLength(model) > 0)
1676 CFStringAppendFormat(extras, NULL, CFSTR("MDL:%@;"), manufacturer);
1677 }
1678
1679 if (serial == NULL && desc.iSerialNumber != 0)
1680 {
1681 serial = printer_interface_indexed_description(printer, desc.iSerialNumber, kUSBLanguageEnglish);
1682 if (CFStringGetLength(serial) > 0)
1683 CFStringAppendFormat(extras, NULL, CFSTR("SERN:%@;"), serial);
1684 }
1685
1686 if (ret != NULL)
1687 {
1688 CFStringAppend(extras, ret);
1689 CFRelease(ret);
1690
1691 ret = extras;
1692 }
1693 else
1694 {
1695 ret = extras;
1696 }
1697 }
1698 }
1699
1700 if (manufacturer != NULL)
1701 CFRelease(manufacturer);
1702 if (model != NULL)
1703 CFRelease(model);
1704 if (serial != NULL)
1705 CFRelease(serial);
1706
1707
1708 /* Remove special characters from the serial number */
1709 CFRange range = (serial != NULL ? CFStringFind(serial, CFSTR("+"), 0) : CFRangeMake(0, 0));
1710 if (range.length == 1)
1711 {
1712 range = CFStringFind(ret, serial, 0);
1713
1714 CFMutableStringRef deviceIDString = CFStringCreateMutableCopy(NULL, 0, ret);
1715 CFRelease(ret);
1716
1717 ret = deviceIDString;
1718 CFStringFindAndReplace(deviceIDString, CFSTR("+"), CFSTR(""), range, 0);
1719 }
1720
1721 return (CFStringGetLength(ret) > 0 ? ret : nil);
1722}
1723
1724static CFStringRef printer_interface_indexed_description(IOUSBInterfaceInterface220 ** printer, UInt8 index, UInt16 language)
1725{
1726 IOReturn err;
1727 UInt8 description[256]; // Max possible descriptor length
1728 IOUSBDevRequestTO request;
1729
1730 bzero(description, 2);
1731
1732 request.bmRequestType = USBmakebmRequestType(kUSBIn, kUSBStandard, kUSBDevice);
1733 request.bRequest = kUSBRqGetDescriptor;
1734 request.wValue = (kUSBStringDesc << 8) | index;
1735 request.wIndex = language;
1736 request.wLength = 2;
1737 request.pData = &description;
1738 request.completionTimeout = 0;
1739 request.noDataTimeout = 60L;
1740
1741 err = (*printer)->ControlRequestTO(printer, 0, &request);
1742 if (err != kIOReturnSuccess && err != kIOReturnOverrun)
1743 {
1744 bzero(description, request.wLength);
1745
1746 // Let's try again full length. Here's why:
1747 // On USB 2.0 controllers, we will not get an overrun error. We just get a "babble" error
1748 // and no valid data. So, if we ask for the max size, we will either get it, or we'll get an underrun.
1749 // It looks like we get it w/out an underrun
1750
1751 request.bmRequestType = USBmakebmRequestType(kUSBIn, kUSBStandard, kUSBDevice);
1752 request.bRequest = kUSBRqGetDescriptor;
1753 request.wValue = (kUSBStringDesc << 8) | index;
1754 request.wIndex = language;
1755 request.wLength = sizeof description;
1756 request.pData = &description;
1757 request.completionTimeout = 0;
1758 request.noDataTimeout = 60L;
1759
1760 err = (*printer)->ControlRequestTO(printer, 0, &request);
1761 if (err != kIOReturnSuccess && err != kIOReturnUnderrun)
1762 return nil;
1763 }
1764
1765 unsigned int length = description[0];
1766 if (length == 0)
1767 return CFStringCreateWithCString(NULL, "", kCFStringEncodingUTF8);
1768
1769 if (description[1] != kUSBStringDesc)
1770 return NULL;
1771
1772 request.bmRequestType = USBmakebmRequestType(kUSBIn, kUSBStandard, kUSBDevice);
1773 request.bRequest = kUSBRqGetDescriptor;
1774 request.wValue = (kUSBStringDesc << 8) | index;
1775 request.wIndex = language;
1776
1777 bzero(description, length);
1778 request.wLength = length;
1779 request.pData = &description;
1780 request.completionTimeout = 0;
1781 request.noDataTimeout = 60L;
1782
1783 err = (*printer)->ControlRequestTO(printer, 0, &request);
1784 if (err != kIOReturnSuccess)
1785 return nil;
1786
1787 if (description[1] != kUSBStringDesc)
1788 return nil;
1789
1790 if ((description[0] & 1) != 0)
1791 description[0] &= 0xfe;
1792
1793 char buffer[258] = {};
1794 unsigned int maxLength = sizeof buffer;
1795 if (description[0] > 1)
1796 {
1797 length = (description[0]-2)/2;
1798
1799 if (length > maxLength - 1)
1800 length = maxLength -1;
1801
1802 for (int i = 0; i < length; i++)
1803 buffer[i] = (char) description[2*i+2];
1804
1805 buffer[length] = 0;
1806 }
1807
1808 return CFStringCreateWithCString(NULL, buffer, kCFStringEncodingUTF8);
1809}
ef416fc2 1810
e53920b9 1811/*
1812 * 'registry_open()' - Open a connection to the printer.
1813 */
ef416fc2 1814
09a101d6 1815static kern_return_t registry_open(CFStringRef *driverBundlePath)
e53920b9 1816{
09a101d6 1817 g.bidi_flag = 0; /* 0=unidirectional */
f7deaa1a 1818
09a101d6 1819 kern_return_t kr = load_printerdriver(driverBundlePath);
1820 if (kr != kIOReturnSuccess)
e53920b9 1821 kr = -2;
ef416fc2 1822
09a101d6 1823 if (g.classdriver != NULL)
1824 {
bc44d920 1825 (*g.classdriver)->interfaceNumber = g.interfaceNum;
09a101d6 1826 kr = (*g.classdriver)->Open(g.classdriver, g.location, kUSBPrintingProtocolBidirectional);
1827 if (kr != kIOReturnSuccess || (*g.classdriver)->interface == NULL)
1828 {
1829 kr = (*g.classdriver)->Open(g.classdriver, g.location, kUSBPrintingProtocolUnidirectional);
1830 if (kr == kIOReturnSuccess)
1831 {
1832 if ((*g.classdriver)->interface == NULL)
1833 {
1834 (*g.classdriver)->Close(g.classdriver);
e53920b9 1835 kr = -1;
1836 }
1837 }
1838 }
09a101d6 1839 else
1840 g.bidi_flag = 1; /* 1=bidirectional */
e53920b9 1841 }
ef416fc2 1842
09a101d6 1843 if (kr != kIOReturnSuccess)
1844 unload_classdriver(&g.classdriver);
ef416fc2 1845
e53920b9 1846 return kr;
1847}
ef416fc2 1848
ef416fc2 1849
e53920b9 1850/*
1851 * 'registry_close()' - Close the connection to the printer.
1852 */
ef416fc2 1853
eac3a0a0 1854static kern_return_t registry_close(void)
ef416fc2 1855{
09a101d6 1856 if (g.classdriver != NULL)
1857 (*g.classdriver)->Close(g.classdriver);
1858
1859 unload_classdriver(&g.classdriver);
e53920b9 1860 return kIOReturnSuccess;
ef416fc2 1861}
1862
e53920b9 1863#pragma mark -
1864/*
1865 * 'copy_value_for_key()' - Copy value string associated with a key.
1866 */
ef416fc2 1867
09a101d6 1868static CFStringRef copy_value_for_key(CFStringRef deviceID,
1869 CFStringRef *keys)
ef416fc2 1870{
e53920b9 1871 CFStringRef value = NULL;
1872 CFArrayRef kvPairs = deviceID != NULL ? CFStringCreateArrayBySeparatingStrings(NULL, deviceID, CFSTR(";")) : NULL;
1873 CFIndex max = kvPairs != NULL ? CFArrayGetCount(kvPairs) : 0;
1874 CFIndex idx = 0;
1875
09a101d6 1876 while (idx < max && value == NULL)
1877 {
e53920b9 1878 CFStringRef kvpair = CFArrayGetValueAtIndex(kvPairs, idx);
1879 CFIndex idxx = 0;
09a101d6 1880 while (keys[idxx] != NULL && value == NULL)
1881 {
e53920b9 1882 CFRange range = CFStringFind(kvpair, keys[idxx], kCFCompareCaseInsensitive);
09a101d6 1883 if (range.length != -1)
1884 {
1885 if (range.location != 0)
1886 {
e53920b9 1887 CFMutableStringRef theString = CFStringCreateMutableCopy(NULL, 0, kvpair);
1888 CFStringTrimWhitespace(theString);
1889 range = CFStringFind(theString, keys[idxx], kCFCompareCaseInsensitive);
09a101d6 1890 if (range.location == 0)
e53920b9 1891 value = CFStringCreateWithSubstring(NULL, theString, CFRangeMake(range.length, CFStringGetLength(theString) - range.length));
09a101d6 1892
e53920b9 1893 CFRelease(theString);
1894 }
09a101d6 1895 else
1896 {
e53920b9 1897 CFStringRef theString = CFStringCreateWithSubstring(NULL, kvpair, CFRangeMake(range.length, CFStringGetLength(kvpair) - range.length));
1898 CFMutableStringRef theString2 = CFStringCreateMutableCopy(NULL, 0, theString);
1899 CFRelease(theString);
ef416fc2 1900
e53920b9 1901 CFStringTrimWhitespace(theString2);
1902 value = theString2;
ef416fc2 1903 }
e53920b9 1904 }
1905 idxx++;
ef416fc2 1906 }
e53920b9 1907 idx++;
1908 }
1909
1910 if (kvPairs != NULL)
09a101d6 1911 CFRelease(kvPairs);
e53920b9 1912 return value;
ef416fc2 1913}
1914
1915
411affcf 1916/*
09a101d6 1917 * 'cfstr_create_trim()' - Create CFString and trim whitespace characters.
411affcf 1918 */
1919
09a101d6 1920CFStringRef cfstr_create_trim(const char *cstr)
411affcf 1921{
1922 CFStringRef cfstr;
1923 CFMutableStringRef cfmutablestr = NULL;
09a101d6 1924
411affcf 1925 if ((cfstr = CFStringCreateWithCString(NULL, cstr, kCFStringEncodingUTF8)) != NULL)
1926 {
1927 if ((cfmutablestr = CFStringCreateMutableCopy(NULL, 1024, cfstr)) != NULL)
1928 CFStringTrimWhitespace(cfmutablestr);
1929
1930 CFRelease(cfstr);
1931 }
1932 return (CFStringRef) cfmutablestr;
1933}
1934
1935
e53920b9 1936#pragma mark -
1937/*
db1f069b 1938 * 'parse_options()' - Parse URI options.
e53920b9 1939 */
ef416fc2 1940
db1f069b 1941static void parse_options(char *options,
09a101d6 1942 char *serial,
76cd9e37 1943 int serial_size,
09a101d6 1944 UInt32 *location,
1945 Boolean *wait_eof)
e53920b9 1946{
db1f069b
MS
1947 char sep, /* Separator character */
1948 *name, /* Name of option */
1949 *value; /* Value of option */
1950
ef416fc2 1951
e53920b9 1952 if (serial)
1953 *serial = '\0';
1954 if (location)
1955 *location = 0;
ef416fc2 1956
e53920b9 1957 if (!options)
1958 return;
ef416fc2 1959
db1f069b 1960 while (*options)
09a101d6 1961 {
db1f069b
MS
1962 /*
1963 * Get the name...
1964 */
ef416fc2 1965
db1f069b 1966 name = options;
ef416fc2 1967
db1f069b 1968 while (*options && *options != '=' && *options != '+' && *options != '&')
e53920b9 1969 options ++;
ef416fc2 1970
db1f069b
MS
1971 if ((sep = *options) != '\0')
1972 *options++ = '\0';
ef416fc2 1973
db1f069b
MS
1974 if (sep == '=')
1975 {
1976 /*
1977 * Get the value...
1978 */
ef416fc2 1979
db1f069b
MS
1980 value = options;
1981
1982 while (*options && *options != '+' && *options != '&')
e53920b9 1983 options ++;
db1f069b
MS
1984
1985 if (*options)
1986 *options++ = '\0';
e53920b9 1987 }
db1f069b
MS
1988 else
1989 value = (char *)"";
ef416fc2 1990
db1f069b
MS
1991 /*
1992 * Process the option...
1993 */
1994
88f9aafc 1995 if (!_cups_strcasecmp(name, "waiteof"))
09a101d6 1996 {
88f9aafc
MS
1997 if (!_cups_strcasecmp(value, "on") ||
1998 !_cups_strcasecmp(value, "yes") ||
1999 !_cups_strcasecmp(value, "true"))
09a101d6 2000 *wait_eof = true;
88f9aafc
MS
2001 else if (!_cups_strcasecmp(value, "off") ||
2002 !_cups_strcasecmp(value, "no") ||
2003 !_cups_strcasecmp(value, "false"))
09a101d6 2004 *wait_eof = false;
2005 else
0837b7e8
MS
2006 _cupsLangPrintFilter(stderr, "WARNING",
2007 _("Boolean expected for waiteof option \"%s\"."),
2008 value);
e53920b9 2009 }
88f9aafc 2010 else if (!_cups_strcasecmp(name, "serial"))
76cd9e37 2011 strlcpy(serial, value, serial_size);
88f9aafc 2012 else if (!_cups_strcasecmp(name, "location") && location)
1a18c85c 2013 *location = (UInt32)strtoul(value, NULL, 16);
e53920b9 2014 }
e53920b9 2015}
ef416fc2 2016
ef416fc2 2017
e53920b9 2018/*!
2019 * @function setup_cfLanguage
ac884b6a 2020 * @abstract Convert the contents of the CUPS 'APPLE_LANGUAGE' environment
e53920b9 2021 * variable into a one element CF array of languages.
2022 *
2023 * @discussion Each submitted job comes with a natural language. CUPS passes
2024 * that language in an environment variable. We take that language
2025 * and jam it into the AppleLanguages array so that CF will use
2026 * it when reading localized resources. We need to do this before
2027 * any CF code reads and caches the languages array, so this function
2028 * should be called early in main()
2029 */
2030static void setup_cfLanguage(void)
2031{
2032 CFStringRef lang[1] = {NULL};
2033 CFArrayRef langArray = NULL;
2034 const char *requestedLang = NULL;
2035
ac884b6a
MS
2036 if ((requestedLang = getenv("APPLE_LANGUAGE")) == NULL)
2037 requestedLang = getenv("LANG");
2038
09a101d6 2039 if (requestedLang != NULL)
2040 {
e53920b9 2041 lang[0] = CFStringCreateWithCString(kCFAllocatorDefault, requestedLang, kCFStringEncodingUTF8);
2042 langArray = CFArrayCreate(kCFAllocatorDefault, (const void **)lang, sizeof(lang) / sizeof(lang[0]), &kCFTypeArrayCallBacks);
2043
28b9d139 2044 CFPreferencesSetValue(CFSTR("AppleLanguages"), langArray, kCFPreferencesCurrentApplication, kCFPreferencesAnyUser, kCFPreferencesAnyHost);
005dd1eb 2045 fprintf(stderr, "DEBUG: usb: AppleLanguages=\"%s\"\n", requestedLang);
e53920b9 2046
2047 CFRelease(lang[0]);
2048 CFRelease(langArray);
e53920b9 2049 }
09a101d6 2050 else
ac884b6a 2051 fputs("DEBUG: usb: LANG and APPLE_LANGUAGE environment variables missing.\n", stderr);
e53920b9 2052}
ef416fc2 2053
e53920b9 2054#pragma mark -
749b1e90 2055#if defined(__i386__) || defined(__x86_64__)
e53920b9 2056/*!
749b1e90 2057 * @function run_legacy_backend
e53920b9 2058 *
749b1e90 2059 * @abstract Starts child backend process running as a ppc or i386 executable.
e53920b9 2060 *
2061 * @result Never returns; always calls exit().
2062 *
09a101d6 2063 * @discussion
e53920b9 2064 */
749b1e90
MS
2065static void run_legacy_backend(int argc,
2066 char *argv[],
2067 int fd)
e53920b9 2068{
2069 int i;
2070 int exitstatus = 0;
2071 int childstatus;
2072 pid_t waitpid_status;
2073 char *my_argv[32];
749b1e90 2074 char *usb_legacy_status;
ef416fc2 2075
1a18c85c 2076
749b1e90
MS
2077 /*
2078 * If we're running as x86_64 or i386 and couldn't load the class driver
2079 * (because it's ppc or i386), then try to re-exec ourselves in ppc or i386
2080 * mode to try again. If we don't have a ppc or i386 architecture we may be
2081 * running with the same architecture again so guard against this by setting
2082 * and testing an environment variable...
2083 */
e53920b9 2084
749b1e90
MS
2085# ifdef __x86_64__
2086 usb_legacy_status = getenv("USB_I386_STATUS");
2087# else
2088 usb_legacy_status = getenv("USB_PPC_STATUS");
2089# endif /* __x86_64__ */
2090
2091 if (!usb_legacy_status)
09a101d6 2092 {
71f63681
MS
2093 log_usb_class_driver(IS_NOT_64BIT);
2094
bc44d920 2095 /*
2096 * Setup a SIGTERM handler then block it before forking...
2097 */
ef416fc2 2098
ef55b745 2099 int err; /* posix_spawn result */
bc44d920 2100 struct sigaction action; /* POSIX signal action */
2101 sigset_t newmask, /* New signal mask */
2102 oldmask; /* Old signal mask */
58dc1933
MS
2103 char usbpath[1024]; /* Path to USB backend */
2104 const char *cups_serverbin;/* Path to CUPS binaries */
2105
bc44d920 2106
2107 memset(&action, 0, sizeof(action));
2108 sigaddset(&action.sa_mask, SIGTERM);
2109 action.sa_handler = sigterm_handler;
2110 sigaction(SIGTERM, &action, NULL);
2111
2112 sigemptyset(&newmask);
2113 sigaddset(&newmask, SIGTERM);
2114 sigprocmask(SIG_BLOCK, &newmask, &oldmask);
ef416fc2 2115
749b1e90
MS
2116 /*
2117 * Set the environment variable...
2118 */
bc44d920 2119
749b1e90
MS
2120# ifdef __x86_64__
2121 setenv("USB_I386_STATUS", "1", false);
2122# else
2123 setenv("USB_PPC_STATUS", "1", false);
2124# endif /* __x86_64__ */
bc44d920 2125
749b1e90
MS
2126 /*
2127 * Tell the kernel to use the specified CPU architecture...
2128 */
bc44d920 2129
749b1e90
MS
2130# ifdef __x86_64__
2131 cpu_type_t cpu = CPU_TYPE_I386;
2132# else
2133 cpu_type_t cpu = CPU_TYPE_POWERPC;
2134# endif /* __x86_64__ */
9a4f8274 2135 size_t ocount = 1;
749b1e90 2136 posix_spawnattr_t attrs;
ef416fc2 2137
749b1e90
MS
2138 if (!posix_spawnattr_init(&attrs))
2139 {
b19ccc9e
MS
2140 posix_spawnattr_setsigdefault(&attrs, &oldmask);
2141 if (posix_spawnattr_setbinpref_np(&attrs, 1, &cpu, &ocount) || ocount != 1)
9a4f8274
MS
2142 {
2143# ifdef __x86_64__
2144 perror("DEBUG: Unable to set binary preference to i386");
2145# else
2146 perror("DEBUG: Unable to set binary preference to ppc");
2147# endif /* __x86_64__ */
0837b7e8
MS
2148 _cupsLangPrintFilter(stderr, "ERROR",
2149 _("Unable to use legacy USB class driver."));
9a4f8274
MS
2150 exit(CUPS_BACKEND_STOP);
2151 }
749b1e90 2152 }
bc44d920 2153
749b1e90
MS
2154 /*
2155 * Set up the arguments and call posix_spawn...
2156 */
ef416fc2 2157
58dc1933
MS
2158 if ((cups_serverbin = getenv("CUPS_SERVERBIN")) == NULL)
2159 cups_serverbin = CUPS_SERVERBIN;
2160 snprintf(usbpath, sizeof(usbpath), "%s/backend/usb", cups_serverbin);
2161
1a18c85c 2162 for (i = 0; i < argc && i < (int)(sizeof(my_argv) / sizeof(my_argv[0])) - 1; i ++)
749b1e90 2163 my_argv[i] = argv[i];
ef416fc2 2164
749b1e90 2165 my_argv[i] = NULL;
ef416fc2 2166
ef55b745
MS
2167 if ((err = posix_spawn(&child_pid, usbpath, NULL, &attrs, my_argv,
2168 environ)) != 0)
09a101d6 2169 {
58dc1933 2170 fprintf(stderr, "DEBUG: Unable to exec %s: %s\n", usbpath,
ef55b745 2171 strerror(err));
0837b7e8
MS
2172 _cupsLangPrintFilter(stderr, "ERROR",
2173 _("Unable to use legacy USB class driver."));
749b1e90 2174 exit(CUPS_BACKEND_STOP);
bc44d920 2175 }
e53920b9 2176
bc44d920 2177 /*
2178 * Unblock signals...
2179 */
e53920b9 2180
bc44d920 2181 sigprocmask(SIG_SETMASK, &oldmask, NULL);
e53920b9 2182
bc44d920 2183 /*
2184 * Close the fds we won't be using then wait for the child backend to exit.
2185 */
2186
2187 close(fd);
2188 close(1);
2189
005dd1eb
MS
2190 fprintf(stderr, "DEBUG: Started usb(legacy) backend (PID %d)\n",
2191 (int)child_pid);
bc44d920 2192
2193 while ((waitpid_status = waitpid(child_pid, &childstatus, 0)) == (pid_t)-1 && errno == EINTR)
2194 usleep(1000);
2195
2196 if (WIFSIGNALED(childstatus))
2197 {
749b1e90 2198 exitstatus = CUPS_BACKEND_STOP;
4d301e69 2199 fprintf(stderr, "DEBUG: usb(legacy) backend %d crashed on signal %d\n",
749b1e90 2200 child_pid, WTERMSIG(childstatus));
ef416fc2 2201 }
09a101d6 2202 else
2203 {
bc44d920 2204 if ((exitstatus = WEXITSTATUS(childstatus)) != 0)
005dd1eb 2205 fprintf(stderr,
4d301e69 2206 "DEBUG: usb(legacy) backend %d stopped with status %d\n",
005dd1eb 2207 child_pid, exitstatus);
bc44d920 2208 else
005dd1eb
MS
2209 fprintf(stderr, "DEBUG: usb(legacy) backend %d exited with no errors\n",
2210 child_pid);
e53920b9 2211 }
2212 }
09a101d6 2213 else
2214 {
005dd1eb 2215 fputs("DEBUG: usb(legacy) backend running native again\n", stderr);
749b1e90 2216 exitstatus = CUPS_BACKEND_STOP;
e53920b9 2217 }
ef416fc2 2218
e53920b9 2219 exit(exitstatus);
2220}
6c48a6ca
MS
2221#endif /* __i386__ || __x86_64__ */
2222
ef416fc2 2223
e53920b9 2224/*
2225 * 'sigterm_handler()' - SIGTERM handler.
2226 */
ef416fc2 2227
f11a948a
MS
2228static void
2229sigterm_handler(int sig) /* I - Signal */
ef416fc2 2230{
6c48a6ca
MS
2231#if defined(__i386__) || defined(__x86_64__)
2232 /*
2233 * If we started a child process pass the signal on to it...
2234 */
2235
e53920b9 2236 if (child_pid)
f11a948a
MS
2237 {
2238 /*
2239 * If we started a child process pass the signal on to it...
2240 */
e53920b9 2241
f11a948a
MS
2242 int status;
2243
2244 kill(child_pid, sig);
2245 while (waitpid(child_pid, &status, 0) < 0 && errno == EINTR);
ef416fc2 2246
f11a948a
MS
2247 if (WIFEXITED(status))
2248 exit(WEXITSTATUS(status));
2249 else if (status == SIGTERM || status == SIGKILL)
2250 exit(0);
2251 else
2252 {
4d301e69 2253 fprintf(stderr, "DEBUG: Child crashed on signal %d\n", status);
f11a948a
MS
2254 exit(CUPS_BACKEND_STOP);
2255 }
2256 }
18ecb428 2257#endif /* __i386__ || __x86_64__ */
6c48a6ca 2258}
18ecb428 2259
ef416fc2 2260
a469f8a5
MS
2261/*
2262 * 'sigquit_handler()' - SIGQUIT handler.
2263 */
2264
2265static void sigquit_handler(int sig, siginfo_t *si, void *unused)
2266{
2267 char *path;
2268 char pathbuf[PROC_PIDPATHINFO_MAXSIZE];
2269 static char msgbuf[256] = "";
2270
2271
2272 (void)sig;
2273 (void)unused;
2274
2275 if (proc_pidpath(si->si_pid, pathbuf, sizeof(pathbuf)) > 0 &&
2276 (path = basename(pathbuf)) != NULL)
2277 snprintf(msgbuf, sizeof(msgbuf), "SIGQUIT sent by %s(%d)", path, (int)si->si_pid);
2278 else
2279 snprintf(msgbuf, sizeof(msgbuf), "SIGQUIT sent by PID %d", (int)si->si_pid);
2280
2281 CRSetCrashLogMessage(msgbuf);
2282
2283 abort();
2284}
2285
2286
e53920b9 2287#ifdef PARSE_PS_ERRORS
2288/*
2289 * 'next_line()' - Find the next line in a buffer.
2290 */
ef416fc2 2291
e53920b9 2292static const char *next_line (const char *buffer)
ef416fc2 2293{
e53920b9 2294 const char *cptr, *lptr = NULL;
ef416fc2 2295
e53920b9 2296 for (cptr = buffer; *cptr && lptr == NULL; cptr++)
2297 if (*cptr == '\n' || *cptr == '\r')
2298 lptr = cptr;
2299 return lptr;
ef416fc2 2300}
2301
ef416fc2 2302
e53920b9 2303/*
2304 * 'parse_pserror()' - Scan the backchannel data for postscript errors.
2305 */
ef416fc2 2306
09a101d6 2307static void parse_pserror(char *sockBuffer,
2308 int len)
ef416fc2 2309{
e53920b9 2310 static char gErrorBuffer[1024] = "";
2311 static char *gErrorBufferPtr = gErrorBuffer;
2312 static char *gErrorBufferEndPtr = gErrorBuffer + sizeof(gErrorBuffer);
2313
2314 char *pCommentBegin, *pCommentEnd, *pLineEnd;
2315 char *logLevel;
2316 char logstr[1024];
2317 int logstrlen;
2318
2319 if (gErrorBufferPtr + len > gErrorBufferEndPtr - 1)
2320 gErrorBufferPtr = gErrorBuffer;
2321 if (len > sizeof(gErrorBuffer) - 1)
2322 len = sizeof(gErrorBuffer) - 1;
2323
2324 memcpy(gErrorBufferPtr, (const void *)sockBuffer, len);
2325 gErrorBufferPtr += len;
2326 *(gErrorBufferPtr + 1) = '\0';
2327
e53920b9 2328 pLineEnd = (char *)next_line((const char *)gErrorBuffer);
09a101d6 2329 while (pLineEnd != NULL)
2330 {
e53920b9 2331 *pLineEnd++ = '\0';
2332
2333 pCommentBegin = strstr(gErrorBuffer,"%%[");
2334 pCommentEnd = strstr(gErrorBuffer, "]%%");
09a101d6 2335 if (pCommentBegin != gErrorBuffer && pCommentEnd != NULL)
2336 {
e53920b9 2337 pCommentEnd += 3; /* Skip past "]%%" */
2338 *pCommentEnd = '\0'; /* There's always room for the nul */
2339
88f9aafc 2340 if (_cups_strncasecmp(pCommentBegin, "%%[ Error:", 10) == 0)
e53920b9 2341 logLevel = "DEBUG";
88f9aafc 2342 else if (_cups_strncasecmp(pCommentBegin, "%%[ Flushing", 12) == 0)
e53920b9 2343 logLevel = "DEBUG";
2344 else
2345 logLevel = "INFO";
2346
09a101d6 2347 if ((logstrlen = snprintf(logstr, sizeof(logstr), "%s: %s\n", logLevel, pCommentBegin)) >= sizeof(logstr))
2348 {
e53920b9 2349 /* If the string was trucnated make sure it has a linefeed before the nul */
2350 logstrlen = sizeof(logstr) - 1;
2351 logstr[logstrlen - 1] = '\n';
2352 }
2353 write(STDERR_FILENO, logstr, logstrlen);
ef416fc2 2354 }
ef416fc2 2355
e53920b9 2356 /* move everything over... */
5a9febac 2357 strlcpy(gErrorBuffer, pLineEnd, sizeof(gErrorBuffer));
e53920b9 2358 gErrorBufferPtr = gErrorBuffer;
2359 pLineEnd = (char *)next_line((const char *)gErrorBuffer);
2360 }
ef416fc2 2361}
e53920b9 2362#endif /* PARSE_PS_ERRORS */
ef416fc2 2363
e53920b9 2364
2365/*
db1f069b 2366 * 'soft_reset()' - Send a soft reset to the device.
ef416fc2 2367 */
e53920b9 2368
eac3a0a0 2369static void soft_reset(void)
ef416fc2 2370{
09a101d6 2371 fd_set input_set; /* Input set for select() */
84315f46 2372 struct timeval tv; /* Time value */
09a101d6 2373 char buffer[2048]; /* Buffer */
2374 struct timespec cond_timeout; /* pthread condition timeout */
e53920b9 2375
09a101d6 2376 /*
2377 * Send an abort once a second until the I/O lock is released by the main thread...
2378 */
e53920b9 2379
09a101d6 2380 pthread_mutex_lock(&g.readwrite_lock_mutex);
2381 while (g.readwrite_lock)
2382 {
2383 (*g.classdriver)->Abort(g.classdriver);
ef416fc2 2384
84315f46
MS
2385 gettimeofday(&tv, NULL);
2386 cond_timeout.tv_sec = tv.tv_sec + 1;
2387 cond_timeout.tv_nsec = tv.tv_usec * 1000;
e53920b9 2388
84315f46
MS
2389 while (g.readwrite_lock)
2390 {
2391 if (pthread_cond_timedwait(&g.readwrite_lock_cond,
2392 &g.readwrite_lock_mutex,
2393 &cond_timeout) != 0)
2394 break;
2395 }
09a101d6 2396 }
f7deaa1a 2397
09a101d6 2398 g.readwrite_lock = 1;
2399 pthread_mutex_unlock(&g.readwrite_lock_mutex);
f7deaa1a 2400
09a101d6 2401 /*
2402 * Flush bytes waiting on print_fd...
2403 */
f7deaa1a 2404
09a101d6 2405 g.print_bytes = 0;
f7deaa1a 2406
09a101d6 2407 FD_ZERO(&input_set);
2408 FD_SET(g.print_fd, &input_set);
f7deaa1a 2409
84315f46
MS
2410 tv.tv_sec = 0;
2411 tv.tv_usec = 0;
f7deaa1a 2412
84315f46 2413 while (select(g.print_fd+1, &input_set, NULL, NULL, &tv) > 0)
09a101d6 2414 if (read(g.print_fd, buffer, sizeof(buffer)) <= 0)
2415 break;
f7deaa1a 2416
09a101d6 2417 /*
2418 * Send the reset...
2419 */
f7deaa1a 2420
7dfedb92 2421 (*g.classdriver)->SoftReset(g.classdriver, DEFAULT_TIMEOUT);
f7deaa1a 2422
09a101d6 2423 /*
2424 * Release the I/O lock...
2425 */
f7deaa1a 2426
09a101d6 2427 pthread_mutex_lock(&g.readwrite_lock_mutex);
2428 g.readwrite_lock = 0;
2429 pthread_cond_signal(&g.readwrite_lock_cond);
2430 pthread_mutex_unlock(&g.readwrite_lock_mutex);
f7deaa1a 2431}
2432
f7deaa1a 2433
2434/*
09a101d6 2435 * 'get_device_id()' - Return IEEE-1284 device ID.
f7deaa1a 2436 */
f7deaa1a 2437
09a101d6 2438static void get_device_id(cups_sc_status_t *status,
2439 char *data,
2440 int *datalen)
2441{
f7deaa1a 2442 CFStringRef deviceIDString = NULL;
2443
a215cf84
MS
2444 if (g.printer_obj != IO_OBJECT_NULL)
2445 {
2446 IOUSBInterfaceInterface220 **intf220 = usb_interface220_for_service(g.printer_obj);
2447 if (intf220)
2448 {
2449 deviceIDString = printer_interface_deviceid(intf220, g.alternateSetting);
2450 (*intf220)->Release(intf220);
2451 }
2452 }
2453
e38f5e9c 2454
09a101d6 2455 if (deviceIDString)
2456 {
a215cf84
MS
2457 if (CFStringGetCString(deviceIDString, data, *datalen, kCFStringEncodingUTF8))
2458 *datalen = (int)strlen(data);
2459 else
2460 *datalen = 0;
2461
09a101d6 2462 CFRelease(deviceIDString);
f7deaa1a 2463 }
a215cf84
MS
2464 else
2465 {
2466 *datalen = 0;
2467 }
2468
09a101d6 2469 *status = CUPS_SC_STATUS_OK;
f7deaa1a 2470}
2471
f7deaa1a 2472
71f63681
MS
2473static void
2474log_usb_class_driver(int is_64bit) /* I - Is the USB class driver 64-bit? */
2475{
2476 /*
2477 * Report the usage of legacy USB class drivers to Apple if the user opts into providing
2478 * feedback to Apple...
2479 */
2480
2481 aslmsg aslm = asl_new(ASL_TYPE_MSG);
2482 if (aslm)
2483 {
2484 ppd_file_t *ppd = ppdOpenFile(getenv("PPD"));
2485 const char *make_model = ppd ? ppd->nickname : NULL;
2486 ppd_attr_t *version = ppdFindAttr(ppd, "FileVersion", "");
2487
2488 asl_set(aslm, "com.apple.message.domain", "com.apple.printing.usb.64bit");
2489 asl_set(aslm, "com.apple.message.result", is_64bit ? "yes" : "no");
2490 asl_set(aslm, "com.apple.message.signature", make_model ? make_model : "Unknown");
2491 asl_set(aslm, "com.apple.message.signature2", version ? version->value : "?.?");
2492 asl_set(aslm, "com.apple.message.summarize", "YES");
2493 asl_log(NULL, aslm, ASL_LEVEL_NOTICE, "");
2494 asl_free(aslm);
2495 }
2496}
2497
2498
f7deaa1a 2499/*
a215cf84 2500 * End of "$Id: usb-darwin.c 12529 2015-02-23 18:57:57Z msweet $".
ef416fc2 2501 */