[thirdparty/cups.git] / backend / network.c

/*
 * "$Id$"
 *
 * Common backend network APIs for CUPS.
 *
 * Copyright 2007-2014 by Apple Inc.
 * Copyright 2006-2007 by Easy Software Products, all rights reserved.
 *
 * These coded instructions, statements, and computer programs are the
 * property of Apple Inc. and are protected by Federal copyright
 * law.  Distribution and use rights are outlined in the file "LICENSE.txt"
 * "LICENSE" which should have been included with this file.  If this
 * file is missing or damaged, see the license at "http://www.cups.org/".
 *
 * This file is subject to the Apple OS-Developed Software exception.
 */

/*
 * Include necessary headers.
 */

#include "backend-private.h"
#include <limits.h>
#include <sys/select.h>


/*
 * 'backendCheckSideChannel()' - Check the side-channel for pending requests.
 */


void
backendCheckSideChannel(
    int         snmp_fd,		/* I - SNMP socket */
    http_addr_t *addr)			/* I - Address of device */
{
  fd_set	input;			/* Select input set */
  struct timeval timeout;		/* Select timeout */


  FD_ZERO(&input);
  FD_SET(CUPS_SC_FD, &input);

  timeout.tv_sec = timeout.tv_usec = 0;

  if (select(CUPS_SC_FD + 1, &input, NULL, NULL, &timeout) > 0)
    backendNetworkSideCB(-1, -1, snmp_fd, addr, 0);
}


/*
 * 'backendNetworkSideCB()' - Handle common network side-channel commands.
 */

int					/* O - -1 on error, 0 on success */
backendNetworkSideCB(
    int         print_fd,		/* I - Print file or -1 */
    int         device_fd,		/* I - Device file or -1 */
    int         snmp_fd,		/* I - SNMP socket */
    http_addr_t *addr,			/* I - Address of device */
    int         use_bc)			/* I - Use back-channel data? */
{
  cups_sc_command_t	command;	/* Request command */
  cups_sc_status_t	status;		/* Request/response status */
  char			data[65536];	/* Request/response data */
  int			datalen;	/* Request/response data size */
  const char		*device_id;	/* 1284DEVICEID env var */


  datalen = sizeof(data);

  if (cupsSideChannelRead(&command, &status, data, &datalen, 1.0))
    return (-1);

  switch (command)
  {
    case CUPS_SC_CMD_DRAIN_OUTPUT :
       /*
        * Our sockets disable the Nagle algorithm and data is sent immediately.
	*/

        if (device_fd < 0)
	  status = CUPS_SC_STATUS_NOT_IMPLEMENTED;
	else if (backendDrainOutput(print_fd, device_fd))
	  status = CUPS_SC_STATUS_IO_ERROR;
	else
          status = CUPS_SC_STATUS_OK;

	datalen = 0;
        break;

    case CUPS_SC_CMD_GET_BIDI :
	status  = CUPS_SC_STATUS_OK;
        data[0] = (char)use_bc;
        datalen = 1;
        break;

    case CUPS_SC_CMD_SNMP_GET :
    case CUPS_SC_CMD_SNMP_GET_NEXT :
        fprintf(stderr, "DEBUG: CUPS_SC_CMD_SNMP_%s: %d (%s)\n",
	        command == CUPS_SC_CMD_SNMP_GET ? "GET" : "GET_NEXT", datalen,
		data);

        if (datalen < 2)
	{
	  status  = CUPS_SC_STATUS_BAD_MESSAGE;
	  datalen = 0;
	  break;
	}

        if (snmp_fd >= 0)
	{
	  char		*dataptr;	/* Pointer into data */
	  cups_snmp_t	packet;		/* Packet from printer */
          const char	*snmp_value;	/* CUPS_SNMP_VALUE env var */

          if ((snmp_value = getenv("CUPS_SNMP_VALUE")) != NULL)
          {
            const char	*snmp_count;	/* CUPS_SNMP_COUNT env var */
            int		count;		/* Repetition count */

            if ((snmp_count = getenv("CUPS_SNMP_COUNT")) != NULL)
            {
              if ((count = atoi(snmp_count)) <= 0)
                count = 1;
            }
            else
              count = 1;

	    for (dataptr = data + strlen(data) + 1;
	         count > 0 && dataptr < (data + sizeof(data) - 1);
	         count --, dataptr += strlen(dataptr))
	      strlcpy(dataptr, snmp_value, sizeof(data) - (size_t)(dataptr - data));

	    fprintf(stderr, "DEBUG: Returning %s %s\n", data,
	            data + strlen(data) + 1);

	    status  = CUPS_SC_STATUS_OK;
	    datalen = (int)(dataptr - data);
	    break;
          }

          if (!_cupsSNMPStringToOID(data, packet.object_name, CUPS_SNMP_MAX_OID))
	  {
	    status  = CUPS_SC_STATUS_BAD_MESSAGE;
	    datalen = 0;
	    break;
	  }

          status  = CUPS_SC_STATUS_IO_ERROR;
	  datalen = 0;

          if (_cupsSNMPWrite(snmp_fd, addr, CUPS_SNMP_VERSION_1,
	                     _cupsSNMPDefaultCommunity(),
	                     command == CUPS_SC_CMD_SNMP_GET ?
			         CUPS_ASN1_GET_REQUEST :
				 CUPS_ASN1_GET_NEXT_REQUEST, 1,
			     packet.object_name))
          {
	    if (_cupsSNMPRead(snmp_fd, &packet, 1.0))
	    {
	      size_t	i;		/* Looping var */


              if (!_cupsSNMPOIDToString(packet.object_name, data, sizeof(data)))
	      {
	        fputs("DEBUG: Bad OID returned!\n", stderr);
	        break;
	      }

	      datalen = (int)strlen(data) + 1;
              dataptr = data + datalen;

	      switch (packet.object_type)
	      {
	        case CUPS_ASN1_BOOLEAN :
		    snprintf(dataptr, sizeof(data) - (size_t)(dataptr - data), "%d", packet.object_value.boolean);
	            datalen += strlen(dataptr);
		    break;

	        case CUPS_ASN1_INTEGER :
		    snprintf(dataptr, sizeof(data) - (size_t)(dataptr - data), "%d",
		             packet.object_value.integer);
	            datalen += strlen(dataptr);
		    break;

	        case CUPS_ASN1_BIT_STRING :
	        case CUPS_ASN1_OCTET_STRING :
		    if (packet.object_value.string.num_bytes < (sizeof(data) - (size_t)(dataptr - data)))
		      i = packet.object_value.string.num_bytes;
		    else
		      i = sizeof(data) - (size_t)(dataptr - data);

		    memcpy(dataptr, packet.object_value.string.bytes, i);

                    datalen += i;
		    break;

	        case CUPS_ASN1_OID :
		    _cupsSNMPOIDToString(packet.object_value.oid, dataptr,
		                         sizeof(data) - (size_t)(dataptr - data));
	            datalen += strlen(dataptr);
		    break;

                case CUPS_ASN1_HEX_STRING :
		    for (i = 0;
		         i < packet.object_value.string.num_bytes &&
			     dataptr < (data + sizeof(data) - 3);
			 i ++, dataptr += 2)
		      sprintf(dataptr, "%02X", packet.object_value.string.bytes[i]);
	            datalen += strlen(dataptr);
		    break;

                case CUPS_ASN1_COUNTER :
		    snprintf(dataptr, sizeof(data) - (size_t)(dataptr - data), "%u", packet.object_value.counter);
	            datalen += strlen(dataptr);
		    break;

                case CUPS_ASN1_GAUGE :
		    snprintf(dataptr, sizeof(data) - (size_t)(dataptr - data), "%u", packet.object_value.gauge);
	            datalen += strlen(dataptr);
		    break;

                case CUPS_ASN1_TIMETICKS :
		    snprintf(dataptr, sizeof(data) - (size_t)(dataptr - data), "%u", packet.object_value.timeticks);
	            datalen += strlen(dataptr);
		    break;

                default :
	            fprintf(stderr, "DEBUG: Unknown OID value type %02X.\n", packet.object_type);

		case CUPS_ASN1_NULL_VALUE :
		    dataptr[0] = '\0';
		    break;
              }

	      fprintf(stderr, "DEBUG: Returning %s %s\n", data, data + datalen);

	      status = CUPS_SC_STATUS_OK;
	    }
	    else
	      fputs("DEBUG: SNMP read error...\n", stderr);
	  }
	  else
	    fputs("DEBUG: SNMP write error...\n", stderr);
	  break;
        }

        status  = CUPS_SC_STATUS_NOT_IMPLEMENTED;
	datalen = 0;
	break;

    case CUPS_SC_CMD_GET_DEVICE_ID :
        if (snmp_fd >= 0)
	{
	  cups_snmp_t	packet;		/* Packet from printer */
	  static const int ppmPrinterIEEE1284DeviceId[] =
	  		{ CUPS_OID_ppmPrinterIEEE1284DeviceId,1,-1 };


          status  = CUPS_SC_STATUS_IO_ERROR;
	  datalen = 0;

          if (_cupsSNMPWrite(snmp_fd, addr, CUPS_SNMP_VERSION_1,
	                     _cupsSNMPDefaultCommunity(),
	                     CUPS_ASN1_GET_REQUEST, 1,
			     ppmPrinterIEEE1284DeviceId))
          {
	    if (_cupsSNMPRead(snmp_fd, &packet, 1.0) &&
	        packet.object_type == CUPS_ASN1_OCTET_STRING)
	    {
	      strlcpy(data, (char *)packet.object_value.string.bytes,
	              sizeof(data));
	      datalen = (int)strlen(data);
	      status  = CUPS_SC_STATUS_OK;
	    }
	  }

	  break;
        }

	if ((device_id = getenv("1284DEVICEID")) != NULL)
	{
	  strlcpy(data, device_id, sizeof(data));
	  datalen = (int)strlen(data);
	  status  = CUPS_SC_STATUS_OK;
	  break;
	}

    case CUPS_SC_CMD_GET_CONNECTED :
	status  = CUPS_SC_STATUS_OK;
        data[0] = device_fd != -1;
        datalen = 1;
        break;

    default :
        status  = CUPS_SC_STATUS_NOT_IMPLEMENTED;
	datalen = 0;
	break;
  }

  return (cupsSideChannelWrite(command, status, data, datalen, 1.0));
}


/*
 * End of "$Id$".
 */
Commit	Line	Data
7a14d768 MS	1	/*
	2	* "$Id$"
	3	*
5a1d7a17	4	* Common backend network APIs for CUPS.
7a14d768	5	*
7e86f2f6	6	* Copyright 2007-2014 by Apple Inc.
5a1d7a17	7	* Copyright 2006-2007 by Easy Software Products, all rights reserved.
7a14d768	8	*
5a1d7a17 MS	9	* These coded instructions, statements, and computer programs are the
	10	* property of Apple Inc. and are protected by Federal copyright
	11	* law. Distribution and use rights are outlined in the file "LICENSE.txt"
	12	* "LICENSE" which should have been included with this file. If this
	13	* file is missing or damaged, see the license at "http://www.cups.org/".
7a14d768	14	*
5a1d7a17	15	* This file is subject to the Apple OS-Developed Software exception.
7a14d768 MS	16	*/
	17
	18	/*
	19	* Include necessary headers.
	20	*/
	21
	22	#include "backend-private.h"
	23	#include <limits.h>
5a1d7a17	24	#include <sys/select.h>
7a14d768 MS	25
7a14d768 MS	26
7a14d768 MS	27	/*
	28	* 'backendCheckSideChannel()' - Check the side-channel for pending requests.
	29	*/
	30
	31
	32	void
	33	backendCheckSideChannel(
	34	int snmp_fd, /* I - SNMP socket */
	35	http_addr_t addr) / I - Address of device */
	36	{
	37	fd_set input; /* Select input set */
	38	struct timeval timeout; /* Select timeout */
	39
	40
	41	FD_ZERO(&input);
	42	FD_SET(CUPS_SC_FD, &input);
	43
	44	timeout.tv_sec = timeout.tv_usec = 0;
	45
	46	if (select(CUPS_SC_FD + 1, &input, NULL, NULL, &timeout) > 0)
	47	backendNetworkSideCB(-1, -1, snmp_fd, addr, 0);
	48	}
	49
	50
	51	/*
	52	* 'backendNetworkSideCB()' - Handle common network side-channel commands.
	53	*/
	54
18ecb428	55	int /* O - -1 on error, 0 on success */
7a14d768 MS	56	backendNetworkSideCB(
	57	int print_fd, /* I - Print file or -1 */
	58	int device_fd, /* I - Device file or -1 */
	59	int snmp_fd, /* I - SNMP socket */
	60	http_addr_t addr, / I - Address of device */
	61	int use_bc) /* I - Use back-channel data? */
	62	{
	63	cups_sc_command_t command; /* Request command */
	64	cups_sc_status_t status; /* Request/response status */
dcb445bc	65	char data[65536]; /* Request/response data */
7a14d768 MS	66	int datalen; /* Request/response data size */
	67	const char device_id; / 1284DEVICEID env var */
	68
	69
	70	datalen = sizeof(data);
	71
	72	if (cupsSideChannelRead(&command, &status, data, &datalen, 1.0))
18ecb428	73	return (-1);
7a14d768 MS	74
	75	switch (command)
	76	{
	77	case CUPS_SC_CMD_DRAIN_OUTPUT :
	78	/*
	79	* Our sockets disable the Nagle algorithm and data is sent immediately.
	80	*/
	81
	82	if (device_fd < 0)
	83	status = CUPS_SC_STATUS_NOT_IMPLEMENTED;
	84	else if (backendDrainOutput(print_fd, device_fd))
	85	status = CUPS_SC_STATUS_IO_ERROR;
82cc1f9a	86	else
7a14d768 MS	87	status = CUPS_SC_STATUS_OK;
	88
	89	datalen = 0;
	90	break;
	91
	92	case CUPS_SC_CMD_GET_BIDI :
8b450588	93	status = CUPS_SC_STATUS_OK;
7e86f2f6	94	data[0] = (char)use_bc;
7a14d768 MS	95	datalen = 1;
	96	break;
	97
20fbc903 MS	98	case CUPS_SC_CMD_SNMP_GET :
	99	case CUPS_SC_CMD_SNMP_GET_NEXT :
	100	fprintf(stderr, "DEBUG: CUPS_SC_CMD_SNMP_%s: %d (%s)\n",
	101	command == CUPS_SC_CMD_SNMP_GET ? "GET" : "GET_NEXT", datalen,
	102	data);
	103
	104	if (datalen < 2)
	105	{
	106	status = CUPS_SC_STATUS_BAD_MESSAGE;
	107	datalen = 0;
	108	break;
	109	}
	110
	111	if (snmp_fd >= 0)
	112	{
82cc1f9a	113	char dataptr; / Pointer into data */
20fbc903	114	cups_snmp_t packet; /* Packet from printer */
82cc1f9a	115	const char snmp_value; / CUPS_SNMP_VALUE env var */
20fbc903	116
82cc1f9a MS	117	if ((snmp_value = getenv("CUPS_SNMP_VALUE")) != NULL)
	118	{
	119	const char snmp_count; / CUPS_SNMP_COUNT env var */
	120	int count; /* Repetition count */
	121
	122	if ((snmp_count = getenv("CUPS_SNMP_COUNT")) != NULL)
	123	{
	124	if ((count = atoi(snmp_count)) <= 0)
	125	count = 1;
	126	}
	127	else
	128	count = 1;
	129
	130	for (dataptr = data + strlen(data) + 1;
	131	count > 0 && dataptr < (data + sizeof(data) - 1);
	132	count --, dataptr += strlen(dataptr))
7e86f2f6	133	strlcpy(dataptr, snmp_value, sizeof(data) - (size_t)(dataptr - data));
82cc1f9a MS	134
	135	fprintf(stderr, "DEBUG: Returning %s %s\n", data,
	136	data + strlen(data) + 1);
	137
	138	status = CUPS_SC_STATUS_OK;
7e86f2f6	139	datalen = (int)(dataptr - data);
82cc1f9a MS	140	break;
82cc1f9a MS	141	}
20fbc903 MS	142
	143	if (!_cupsSNMPStringToOID(data, packet.object_name, CUPS_SNMP_MAX_OID))
	144	{
	145	status = CUPS_SC_STATUS_BAD_MESSAGE;
	146	datalen = 0;
	147	break;
	148	}
	149
	150	status = CUPS_SC_STATUS_IO_ERROR;
	151	datalen = 0;
	152
	153	if (_cupsSNMPWrite(snmp_fd, addr, CUPS_SNMP_VERSION_1,
	154	_cupsSNMPDefaultCommunity(),
	155	command == CUPS_SC_CMD_SNMP_GET ?
	156	CUPS_ASN1_GET_REQUEST :
	157	CUPS_ASN1_GET_NEXT_REQUEST, 1,
	158	packet.object_name))
	159	{
	160	if (_cupsSNMPRead(snmp_fd, &packet, 1.0))
	161	{
7e86f2f6	162	size_t i; /* Looping var */
20fbc903 MS	163
	164
	165	if (!_cupsSNMPOIDToString(packet.object_name, data, sizeof(data)))
	166	{
	167	fputs("DEBUG: Bad OID returned!\n", stderr);
	168	break;
	169	}
	170
	171	datalen = (int)strlen(data) + 1;
	172	dataptr = data + datalen;
	173
	174	switch (packet.object_type)
	175	{
	176	case CUPS_ASN1_BOOLEAN :
7e86f2f6 MS	177	snprintf(dataptr, sizeof(data) - (size_t)(dataptr - data), "%d", packet.object_value.boolean);
7e86f2f6 MS	178	datalen += strlen(dataptr);
20fbc903 MS	179	break;
	180
	181	case CUPS_ASN1_INTEGER :
7e86f2f6	182	snprintf(dataptr, sizeof(data) - (size_t)(dataptr - data), "%d",
20fbc903	183	packet.object_value.integer);
7e86f2f6	184	datalen += strlen(dataptr);
20fbc903 MS	185	break;
	186
	187	case CUPS_ASN1_BIT_STRING :
	188	case CUPS_ASN1_OCTET_STRING :
7e86f2f6	189	if (packet.object_value.string.num_bytes < (sizeof(data) - (size_t)(dataptr - data)))
d1c13e16	190	i = packet.object_value.string.num_bytes;
ef55b745	191	else
7e86f2f6	192	i = sizeof(data) - (size_t)(dataptr - data);
d1c13e16 MS	193
	194	memcpy(dataptr, packet.object_value.string.bytes, i);
	195
	196	datalen += i;
20fbc903 MS	197	break;
	198
	199	case CUPS_ASN1_OID :
	200	_cupsSNMPOIDToString(packet.object_value.oid, dataptr,
7e86f2f6 MS	201	sizeof(data) - (size_t)(dataptr - data));
7e86f2f6 MS	202	datalen += strlen(dataptr);
20fbc903 MS	203	break;
	204
	205	case CUPS_ASN1_HEX_STRING :
	206	for (i = 0;
d1c13e16	207	i < packet.object_value.string.num_bytes &&
20fbc903 MS	208	dataptr < (data + sizeof(data) - 3);
20fbc903 MS	209	i ++, dataptr += 2)
7e86f2f6 MS	210	sprintf(dataptr, "%02X", packet.object_value.string.bytes[i]);
7e86f2f6 MS	211	datalen += strlen(dataptr);
20fbc903 MS	212	break;
	213
	214	case CUPS_ASN1_COUNTER :
7e86f2f6 MS	215	snprintf(dataptr, sizeof(data) - (size_t)(dataptr - data), "%u", packet.object_value.counter);
7e86f2f6 MS	216	datalen += strlen(dataptr);
20fbc903 MS	217	break;
	218
	219	case CUPS_ASN1_GAUGE :
7e86f2f6 MS	220	snprintf(dataptr, sizeof(data) - (size_t)(dataptr - data), "%u", packet.object_value.gauge);
7e86f2f6 MS	221	datalen += strlen(dataptr);
20fbc903 MS	222	break;
	223
	224	case CUPS_ASN1_TIMETICKS :
7e86f2f6 MS	225	snprintf(dataptr, sizeof(data) - (size_t)(dataptr - data), "%u", packet.object_value.timeticks);
7e86f2f6 MS	226	datalen += strlen(dataptr);
20fbc903 MS	227	break;
	228
	229	default :
7e86f2f6	230	fprintf(stderr, "DEBUG: Unknown OID value type %02X.\n", packet.object_type);
d1c13e16 MS	231
	232	case CUPS_ASN1_NULL_VALUE :
	233	dataptr[0] = '\0';
20fbc903 MS	234	break;
	235	}
	236
	237	fprintf(stderr, "DEBUG: Returning %s %s\n", data, data + datalen);
	238
d1c13e16	239	status = CUPS_SC_STATUS_OK;
20fbc903 MS	240	}
	241	else
	242	fputs("DEBUG: SNMP read error...\n", stderr);
	243	}
	244	else
	245	fputs("DEBUG: SNMP write error...\n", stderr);
	246	break;
	247	}
	248
	249	status = CUPS_SC_STATUS_NOT_IMPLEMENTED;
	250	datalen = 0;
	251	break;
	252
7a14d768 MS	253	case CUPS_SC_CMD_GET_DEVICE_ID :
	254	if (snmp_fd >= 0)
	255	{
	256	cups_snmp_t packet; /* Packet from printer */
	257	static const int ppmPrinterIEEE1284DeviceId[] =
	258	{ CUPS_OID_ppmPrinterIEEE1284DeviceId,1,-1 };
	259
20fbc903 MS	260
	261	status = CUPS_SC_STATUS_IO_ERROR;
	262	datalen = 0;
	263
	264	if (_cupsSNMPWrite(snmp_fd, addr, CUPS_SNMP_VERSION_1,
	265	_cupsSNMPDefaultCommunity(),
7a14d768 MS	266	CUPS_ASN1_GET_REQUEST, 1,
	267	ppmPrinterIEEE1284DeviceId))
	268	{
	269	if (_cupsSNMPRead(snmp_fd, &packet, 1.0) &&
	270	packet.object_type == CUPS_ASN1_OCTET_STRING)
	271	{
d1c13e16 MS	272	strlcpy(data, (char *)packet.object_value.string.bytes,
d1c13e16 MS	273	sizeof(data));
7a14d768	274	datalen = (int)strlen(data);
20fbc903	275	status = CUPS_SC_STATUS_OK;
7a14d768 MS	276	}
7a14d768 MS	277	}
20fbc903 MS	278
20fbc903 MS	279	break;
7a14d768 MS	280	}
	281
	282	if ((device_id = getenv("1284DEVICEID")) != NULL)
	283	{
	284	strlcpy(data, device_id, sizeof(data));
	285	datalen = (int)strlen(data);
d1c13e16	286	status = CUPS_SC_STATUS_OK;
7a14d768 MS	287	break;
	288	}
	289
f14324a7 MS	290	case CUPS_SC_CMD_GET_CONNECTED :
	291	status = CUPS_SC_STATUS_OK;
	292	data[0] = device_fd != -1;
	293	datalen = 1;
	294	break;
	295
7a14d768 MS	296	default :
	297	status = CUPS_SC_STATUS_NOT_IMPLEMENTED;
	298	datalen = 0;
	299	break;
	300	}
	301
18ecb428	302	return (cupsSideChannelWrite(command, status, data, datalen, 1.0));
7a14d768 MS	303	}
	304
	305
7a14d768 MS	306	/*
	307	* End of "$Id$".
	308	*/