Gutenprint + CUPS backends for Dye Sublimation printers
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
selphy_print/backend_common.c

2042 lines
51 KiB

/*
* CUPS Backend common code
*
* Copyright (c) 2007-2022 Solomon Peachy <pizza@shaftnet.org>
*
* The latest version of this program can be found at:
*
* https://git.shaftnet.org/cgit/selphy_print.git
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 3 of the License, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses/>.
*
* SPDX-License-Identifier: GPL-3.0+
*
*/
#include "backend_common.h"
#include <errno.h>
#include <signal.h>
#include <strings.h> /* For strncasecmp */
#define BACKEND_VERSION "0.123"
#ifndef CORRTABLE_PATH
#ifdef PACKAGE_DATA_DIR
#define CORRTABLE_PATH PACKAGE_DATA_DIR "/backend_data"
#else
#error "Must define CORRTABLE_PATH or PACKAGE_DATA_DIR!"
#endif
#endif
#define URB_XFER_SIZE (64*1024)
#define XFER_TIMEOUT 15000
#define USB_SUBCLASS_PRINTER 0x1
#define USB_INTERFACE_PROTOCOL_BIDIR 0x2
#define USB_INTERFACE_PROTOCOL_IPP 0x4
/* Global Variables */
int dyesub_debug = 0;
int terminate = 0;
int fast_return = 0;
int extra_vid = -1;
int extra_pid = -1;
int extra_type = -1;
int ncopies = 1;
int collate = 0;
int test_mode = 0;
int quiet = 0;
int stats_only = 0;
FILE *logger;
const char *corrtable_path = CORRTABLE_PATH;
static int max_xfer_size = URB_XFER_SIZE;
static int xfer_timeout = XFER_TIMEOUT;
#ifdef OLD_URI
static int old_uri = 1;
#else
static int old_uri = 0;
#endif
/* Support Functions */
int backend_claim_interface(struct libusb_device_handle *dev, int iface,
int num_claim_attempts)
{
int ret;
do {
ret = libusb_claim_interface(dev, iface);
if (!ret)
break;
if (ret != LIBUSB_ERROR_BUSY)
break;
if (--num_claim_attempts == 0)
break;
sleep(1);
} while (1);
if (ret)
ERROR("Failed to claim interface %d (%d)\n", iface, ret);
return ret;
}
static int lookup_printer_type(struct dyesub_backend *backend, uint16_t idVendor, uint16_t idProduct)
{
int i;
int type = P_UNKNOWN;
for (i = 0 ; backend->devices[i].vid ; i++) {
if (extra_pid != -1 &&
extra_vid != -1 &&
extra_type != -1) {
if (backend->devices[i].type == extra_type &&
extra_vid == idVendor &&
extra_pid == idProduct) {
return extra_type;
}
}
if (idVendor == backend->devices[i].vid &&
idProduct == backend->devices[i].pid) {
return backend->devices[i].type;
}
}
return type;
}
/* Interface **MUST** already be claimed! */
#define ID_BUF_SIZE 2048
char *get_device_id(struct libusb_device_handle *dev, int iface)
{
int length;
char *buf = malloc(ID_BUF_SIZE + 1);
if (!buf) {
ERROR("Memory allocation failure (%d bytes)\n", ID_BUF_SIZE+1);
return NULL;
}
if (libusb_control_transfer(dev,
LIBUSB_REQUEST_TYPE_CLASS | LIBUSB_ENDPOINT_IN |
LIBUSB_RECIPIENT_INTERFACE,
0, 0,
(iface << 8),
(unsigned char *)buf, ID_BUF_SIZE, 5000) < 0)
{
*buf = '\0';
goto done;
}
/* length is the first two bytes, MSB first */
length = (((unsigned)buf[0] & 255) << 8) |
((unsigned)buf[1] & 255);
/* Sanity checks */
if (length > ID_BUF_SIZE || length < 14)
length = (((unsigned)buf[1] & 255) << 8) |
((unsigned)buf[0] & 255);
if (length > ID_BUF_SIZE)
length = ID_BUF_SIZE;
if (length < 14) {
*buf = '\0';
goto done;
}
/* IEEE1284 length field includs the header! */
length -= 2;
/* Move, and terminate */
memmove(buf, buf + 2, length);
buf[length] = '\0';
done:
return buf;
}
/* Used with the IEEE1284 deviceid string parsing */
int parse1284_data(const char *device_id, struct deviceid_dict* dict)
{
char *ptr;
char key[256];
char val[256];
int num = 0;
if (!device_id)
return CUPS_BACKEND_OK;
//[whitespace]key[whitespace]:[whitespace]value[whitespace];
while (*device_id && num < MAX_DICT) {
/* Skip leading spaces */
if (*device_id == ' ')
device_id++;
if (!*device_id)
break;
/* Work out key */
for (ptr = key; *device_id && *device_id != ':'; device_id++)
*ptr++ = *device_id;
if (!*device_id)
break;
while (ptr > key && *(ptr-1) == ' ')
ptr--;
*ptr = 0;
device_id++;
if (!*device_id)
break;
/* Next up, value */
for (ptr = val; *device_id && *device_id != ';'; device_id++)
*ptr++ = *device_id;
while (ptr > val && *(ptr-1) == ' ')
ptr--;
*ptr = 0;
device_id++;
/* Add it to the dictionary */
dict[num].key = strdup(key);
dict[num].val = strdup(val);
num++;
if (!*device_id)
break;
}
return num;
}
char *dict_find(const char *key, int dlen, struct deviceid_dict* dict)
{
while(dlen) {
if (!strcmp(key, dict->key))
return dict->val;
dlen--;
dict++;
}
return NULL;
}
/* I/O functions */
int read_data(struct dyesub_connection *conn, uint8_t *buf, int buflen, int *readlen)
{
int ret;
/* Clear buffer */
memset(buf, 0, buflen);
ret = libusb_bulk_transfer(conn->dev, conn->endp_up,
buf,
buflen,
readlen,
xfer_timeout);
if (ret < 0) {
ERROR("Failure to receive data from printer (libusb error %d: (%d/%d from 0x%02x))\n", ret, *readlen, buflen, conn->endp_up);
goto done;
}
if (dyesub_debug) {
DEBUG("Received %d bytes from printer\n", *readlen);
}
if ((dyesub_debug > 1 && *readlen < 4096) ||
dyesub_debug > 2) {
int i = *readlen;
DEBUG("<- ");
while(i > 0) {
if ((*readlen-i) != 0 &&
(*readlen-i) % 16 == 0) {
DEBUG2("\n");
DEBUG(" ");
}
DEBUG2("%02x ", buf[*readlen-i]);
i--;
}
DEBUG2("\n");
}
done:
return ret;
}
int send_data(struct dyesub_connection *conn, const uint8_t *buf, int len)
{
int num = 0;
if (dyesub_debug) {
DEBUG("Sending %d bytes to printer\n", len);
}
while (len) {
int len2 = (len > max_xfer_size) ? max_xfer_size: len;
if ((dyesub_debug > 1 && len2 < 4096) ||
dyesub_debug > 2) {
int i = len2;
DEBUG("-> ");
while(i > 0) {
if ((len2-i) != 0 &&
(len2-i) % 16 == 0) {
DEBUG2("\n");
DEBUG(" ");
}
DEBUG2("%02x ", buf[len2-i]);
i--;
}
DEBUG2("\n");
}
int ret = libusb_bulk_transfer(conn->dev, conn->endp_down,
(uint8_t*) buf, len2,
&num, xfer_timeout);
if (ret < 0) {
ERROR("Failure to send data to printer (libusb error %d: (%d/%d to 0x%02x))\n", ret, num, len2, conn->endp_down);
return ret;
}
len -= num;
buf += num;
}
return CUPS_BACKEND_OK;
}
/* More stuff */
#ifndef _WIN32
static void sigterm_handler(int signum) {
UNUSED(signum);
terminate = 1;
INFO("Job Cancelled");
}
#endif
static char *sanitize_string(char *str) {
int len = strlen(str);
while(len && (str[len-1] <= 0x20)) {
str[len-1] = 0;
len--;
}
return str;
}
/*
These functions are Public Domain code obtained from:
https://www.geekhideout.com/urlcode.shtml
*/
#include <ctype.h> /* for isalnum() */
static char to_hex(char code) {
static const char hex[] = "0123456789abcdef";
return hex[code & 15];
}
static char from_hex(char ch) {
return isdigit(ch) ? ch - '0' : tolower(ch) - 'a' + 10;
}
/* Note -- caller must free returned pointer! */
static char *url_encode(const char *str) {
const char *pstr = str;
char *buf = malloc(strlen(str) * 3 + 1);
char *pbuf = buf;
if (!buf) {
ERROR("Memory allocation failure (%d bytes)\n", (int) strlen(str)*3 + 1);
return NULL;
}
while (*pstr) {
if (isalnum(*pstr) || *pstr == '-' || *pstr == '_' || *pstr == '.' || *pstr == '~')
*pbuf++ = *pstr;
else if (*pstr == ' ')
*pbuf++ = '+';
else
*pbuf++ = '%', *pbuf++ = to_hex(*pstr >> 4), *pbuf++ = to_hex(*pstr & 15);
pstr++;
}
*pbuf = '\0';
return buf;
}
static char *url_decode(char *str) {
char *pstr = str, *buf = malloc(strlen(str) + 1), *pbuf = buf;
if (!buf) {
ERROR("Memory allocation failure (%d bytes)\n", (int) strlen(str) + 1);
return NULL;
}
while (*pstr) {
if (*pstr == '%') {
if (pstr[1] && pstr[2]) {
*pbuf++ = from_hex(pstr[1]) << 4 | from_hex(pstr[2]);
pstr += 2;
}
} else if (*pstr == '+') {
*pbuf++ = ' ';
} else {
*pbuf++ = *pstr;
}
pstr++;
}
*pbuf = '\0';
return buf;
}
/* And now back to our regularly-scheduled programming */
static int probe_device(struct libusb_device *device,
struct libusb_device_descriptor *desc,
const char *make,
const char *uri_prefix, const char *manuf_override,
int found, int num_claim_attempts,
int scan_only, const char *match_serno,
struct dyesub_connection *conn,
struct dyesub_backend *backend)
{
struct libusb_device_handle *dev;
char buf[256];
char *product = NULL, *serial = NULL, *manuf = NULL, *descr = NULL;
uint8_t iface, altset;
struct libusb_config_descriptor *config = NULL;
int dlen = 0;
struct deviceid_dict dict[MAX_DICT];
char *ieee_id = NULL;
int i;
uint8_t endp_up, endp_down;
DEBUG("Probing VID: %04X PID: %04x\n", desc->idVendor, desc->idProduct);
if ((i = libusb_open(device, &dev))) {
#ifdef _WIN32
if (i == LIBUSB_ERROR_NOT_SUPPORTED)
ERROR("Could not open device %04x:%04x! (Genric USB driver missing, See README)\n", desc->idVendor, desc->idProduct);
else
#endif
ERROR("Could not open device %04x:%04x - %d (need to be root?)\n", desc->idVendor, desc->idProduct, i);
found = -1;
goto abort;
}
#if 0
/* XXX FIXME: Iterate through bNumConfigurations */
/* Force reset of device configuration */
{
int cfgnum = -1;
if (libusb_get_configuration(dev, &cfgnum)) {
ERROR("Can't get config!");
}
INFO("Config %d\n", config);
if (config < 1)
cfgnum = 1;
if (libusb_set_configuration(dev, cfgnum)) {
ERROR("Can't set config\n");
}
}
#endif
/* Get descriptor for active configuration */
if (libusb_get_active_config_descriptor(device, &config)) {
found = -1;
goto abort_close;
}
/* Loop through all interfaces and altsettings to find candidates */
for (iface = 0 ; iface < config->bNumInterfaces ; iface ++) {
for (altset = 0 ; altset < config->interface[iface].num_altsetting ; altset++) {
/* Skip interfaces that don't have enough endpoints */
if (config->interface[iface].altsetting[altset].bNumEndpoints < 2) {
continue;
}
/* Note we actually only match on explicit VID+PIDs so there's no need to filter based
on specific class/type */
/* Explicitly exclude IPP-over-USB interfaces */
if (desc->bDeviceClass == LIBUSB_CLASS_PER_INTERFACE &&
config->interface[iface].altsetting[altset].bInterfaceClass == LIBUSB_CLASS_PRINTER &&
config->interface[iface].altsetting[altset].bInterfaceSubClass == USB_SUBCLASS_PRINTER &&
config->interface[iface].altsetting[altset].bInterfaceProtocol == USB_INTERFACE_PROTOCOL_IPP) {
continue;
}
/* Find the first set of endpoints! */
endp_up = endp_down = 0;
for (i = 0 ; i < config->interface[iface].altsetting[altset].bNumEndpoints ; i++) {
if ((config->interface[iface].altsetting[altset].endpoint[i].bmAttributes & LIBUSB_TRANSFER_TYPE_MASK) == LIBUSB_TRANSFER_TYPE_BULK) {
if (config->interface[iface].altsetting[altset].endpoint[i].bEndpointAddress & LIBUSB_ENDPOINT_IN)
endp_up = config->interface[iface].altsetting[altset].endpoint[i].bEndpointAddress;
else
endp_down = config->interface[iface].altsetting[altset].endpoint[i].bEndpointAddress;
}
if (endp_up && endp_down)
goto candidate;
}
}
}
/* If we got here, we didn't find a match. */
found = -1;
goto abort_close;
candidate:
/* We've now found an interface/altset we need to query in more detail */
/* Detach the kernel driver */
if (libusb_kernel_driver_active(dev, iface))
libusb_detach_kernel_driver(dev, iface);
/* Claim the interface so we can start querying things! */
if (backend_claim_interface(dev, iface, num_claim_attempts)) {
found = -1;
goto abort_release;
}
/* Use the appropriate altesetting, but only if the
printer supports more than one. Some printers don't like
us unconditionally setting this. */
if (config->interface[iface].num_altsetting > 1) {
if (libusb_set_interface_alt_setting(dev, iface, altset)) {
ERROR("Failed to set alternative interface %d/%d\n", iface, altset);
found = -1;
goto abort_release;
}
}
/* Query IEEE1284 info only if it's a PRINTER class */
if (desc->bDeviceClass == LIBUSB_CLASS_PRINTER ||
(desc->bDeviceClass == LIBUSB_CLASS_PER_INTERFACE &&
config->interface[iface].altsetting[altset].bInterfaceClass == LIBUSB_CLASS_PRINTER &&
config->interface[iface].altsetting[altset].bInterfaceSubClass == USB_SUBCLASS_PRINTER)) {
ieee_id = get_device_id(dev, iface);
dlen = parse1284_data(ieee_id, dict);
}
if (!old_uri && !scan_only && !dyesub_debug) goto skip_manuf_model;
/* Look up mfg string in IEEE1284 data */
if (manuf_override && strlen(manuf_override)) {
manuf = url_encode(manuf_override);
} else if ((manuf = dict_find("MANUFACTURER", dlen, dict))) {
manuf = url_encode(manuf);
} else if ((manuf = dict_find("MFG", dlen, dict))) {
manuf = url_encode(manuf);
} else if ((manuf = dict_find("MFR", dlen, dict))) {
manuf = url_encode(manuf);
}
/* If no manufacturer string, fall back to USB iManufacturer */
if ((!manuf || !strlen(manuf)) &&
desc->iManufacturer) {
buf[0] = 0;
libusb_get_string_descriptor_ascii(dev, desc->iManufacturer, (unsigned char*)buf, STR_LEN_MAX);
sanitize_string(buf);
manuf = url_encode(buf);
}
if (!manuf || !strlen(manuf)) { /* Last-ditch */
if (manuf) free(manuf);
WARNING("**** THIS PRINTER DOES NOT REPORT A VALID MANUFACTURER STRING!\n");
6 years ago
manuf = url_encode("Unknown"); // XXX use USB VID?
}
/* Look up model string in IEEE1284 data */
if ((product = dict_find("MODEL", dlen, dict))) {
product = url_encode(product);
} else if ((product = dict_find("MDL", dlen, dict))) {
product = url_encode(product);
}
/* If no manufacturer string, fall back to USB iProduct */
if ((!product || !strlen(product)) &&
desc->iProduct) {
buf[0] = 0;
libusb_get_string_descriptor_ascii(dev, desc->iProduct, (unsigned char*)buf, STR_LEN_MAX);
sanitize_string(buf);
product = url_encode(buf);
}
if (!product || !strlen(product)) { /* Last-ditch */
if (!product) free(product);
WARNING("**** THIS PRINTER DOES NOT REPORT A VALID MODEL STRING!\n");
6 years ago
product = url_encode("Unknown"); // XXX Use USB PID?
}
/* Look up decription string in IEEE1284 data */
if ((descr = dict_find("DESCRIPTION", dlen, dict))) {
descr = strdup(descr);
} else if ((descr = dict_find("DES", dlen, dict))) {
descr = strdup(descr);
}
if (!descr || !strlen(descr)) { /* Last-ditch, generate */
char *product2 = url_decode(product);
char *manuf3 = url_decode(manuf);
descr = malloc(514); /* 256 + 256 + 1 + 1 */
if (!descr) {
ERROR("Memory allocation failure (%d bytes)\n", 514);
if (manuf3)
free(manuf3);
if (product2)
free(product2);
return -1;
}
snprintf(descr, 514, "%s %s", manuf3, product2);
free(product2);
free(manuf3);
}
skip_manuf_model:
/* Prefer IEEE1284-reported serial number */
if ((serial = dict_find("SERIALNUMBER", dlen, dict))) {
serial = url_encode(serial);
} else if ((serial = dict_find("SN", dlen, dict))) {
serial = url_encode(serial);
} else if ((serial = dict_find("SER", dlen, dict))) {
serial = url_encode(serial);
} else if ((serial = dict_find("SERN", dlen, dict))) {
serial = url_encode(serial);
}
/* If it's not valid, fall back to USB iSerial */
if ((!serial || !strlen(serial)) &&
!(backend->flags & BACKEND_FLAG_BADISERIAL) &&
desc->iSerialNumber) {
libusb_get_string_descriptor_ascii(dev, desc->iSerialNumber, (unsigned char*)buf, STR_LEN_MAX);
sanitize_string(buf);
serial = url_encode(buf);
}
/* TODO: What about situations where iSerial does not match IEEE1284?
Or if the '1284 data is bogus? */
/* If still no serial, fall back to backend hook */
if ((!serial || !strlen(serial)) &&
backend->query_serno) { /* Get from backend hook */
struct dyesub_connection c2;
c2.dev = dev;
c2.iface = iface;
c2.altset = altset;
c2.endp_up = endp_up;
c2.endp_down = endp_down;
backend->query_serno(&c2, buf, STR_LEN_MAX);
serial = url_encode(buf);
}
9 years ago
/* Last-ditch serial number fallback */
if (!serial || !strlen(serial)) {
if (serial) free(serial);
WARNING("**** THIS PRINTER DOES NOT REPORT A SERIAL NUMBER!\n");
9 years ago
WARNING("**** If you intend to use multiple printers of this type, you\n");
WARNING("**** must only plug one in at a time or unexpected behavior will occur!\n");
serial = strdup("NONE_UNKNOWN");
}
if (scan_only) {
if (!old_uri) {
fprintf(stdout, "direct %s://%s/%s \"%s\" \"%s\" \"%s\" \"\"\n",
uri_prefix, make, serial,
descr, descr,
ieee_id ? ieee_id : "");
} else {
int k = 0;
/* URLify the manuf and model strings */
strncpy(buf, manuf, sizeof(buf) - 2);
k = strlen(buf);
buf[k++] = '/';
buf[k] = 0;
strncpy(buf + k, product, sizeof(buf)-k);
fprintf(stdout, "direct %s://%s?serial=%s&backend=%s \"%s\" \"%s\" \"%s\" \"\"\n",