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

/*
 * "$Id$"
 *
 *   Common network APIs for the Common UNIX Printing System (CUPS).
 *
 *   Copyright 2007-2009 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.
 *
 * Contents:
 *
 *   backendCheckSideChannel() - Check the side-channel for pending requests.
 *   backendNetworkSideCB()    - Handle common network side-channel commands.
 */

/*
 * Include necessary headers.
 */

#include "backend-private.h"
#include <limits.h>
#ifdef __hpux
#  include <sys/time.h>
#else
#  include <sys/select.h>
#endif /* __hpux */


/*
 * '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[2048];	/* 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] = 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)
	{
	  cups_snmp_t	packet;		/* Packet from printer */


          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))
	    {
	      char	*dataptr;	/* Pointer into data */
	      int	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) - (dataptr - data), "%d",
		             packet.object_value.boolean);
	            datalen += (int)strlen(dataptr);
		    break;

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

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

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

                    datalen += i;
		    break;

	        case CUPS_ASN1_OID :
		    _cupsSNMPOIDToString(packet.object_value.oid, dataptr,
		                         sizeof(data) - (dataptr - data));
	            datalen += (int)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 += (int)strlen(dataptr);
		    break;

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

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

                case CUPS_ASN1_TIMETICKS :
		    snprintf(dataptr, sizeof(data) - (dataptr - data), "%u",
		             packet.object_value.timeticks);
	            datalen += (int)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;
	}

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