backend/network.c - platform/external/libcups - Git at Google

 /*
  * Common backend network APIs for CUPS.
  *
  * Copyright © 2007-2016 by Apple Inc.
  * Copyright © 2006-2007 by Easy Software Products, all rights reserved.
  *
  * Licensed under Apache License v2.0.  See the file "LICENSE" for more
  * information.
  */

 /*
  * 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);
 }


 /*
  * 'backendLookup()' - Lookup the given host and log addresses.
  */

 http_addrlist_t	*			/* O - List of addresses or NULL */
 backendLookup(const char *hostname,	/* I - Hostname */
               int        port,		/* I - Port number */
 	      int        *cancel)	/* I - Variable to watch for job cancel */
 {
   char			portname[32],	/* Port number as string */
 			addrname[256];	/* Address as string */
   http_addrlist_t	*addrlist,	/* List of addresses */
 			*current;	/* Current address */


  /*
   * Lookup the address for the named host...
   */

   snprintf(portname, sizeof(portname), "%d", port);

   fputs("STATE: +connecting-to-device\n", stderr);
   fprintf(stderr, "DEBUG: Looking up \"%s\"...\n", hostname);

   while ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL)
   {
     _cupsLangPrintFilter(stderr, "INFO", _("Unable to locate printer \"%s\"."), hostname);
     sleep(10);

     if (getenv("CLASS") != NULL)
     {
       fputs("STATE: -connecting-to-device\n", stderr);
       exit(CUPS_BACKEND_STOP);
     }

     if (cancel && *cancel)
     {
       fputs("STATE: -connecting-to-device\n", stderr);
       exit(CUPS_BACKEND_OK);
     }
   }

   fputs("STATE: -connecting-to-device\n", stderr);

  /*
   * Log the addresses we got...
   */

   for (current = addrlist; current; current = current->next)
     fprintf(stderr, "DEBUG: %s=%s\n", hostname, httpAddrString(&current->addr, addrname, sizeof(addrname)));

  /*
   * Return...
   */

   return (addrlist);
 }


 /*
  * '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 += (int)strlen(dataptr);
 		    break;

 	        case CUPS_ASN1_INTEGER :
 		    snprintf(dataptr, sizeof(data) - (size_t)(dataptr - data), "%d",
 		             packet.object_value.integer);
 	            datalen += (int)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 += (int)i;
 		    break;

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

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

                 case CUPS_ASN1_TIMETICKS :
 		    snprintf(dataptr, sizeof(data) - (size_t)(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_CONNECTED :
 	status  = CUPS_SC_STATUS_OK;
         data[0] = device_fd != -1;
         datalen = 1;
         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));
 }
	/*
	* Common backend network APIs for CUPS.
	*
	* Copyright © 2007-2016 by Apple Inc.
	* Copyright © 2006-2007 by Easy Software Products, all rights reserved.
	*
	* Licensed under Apache License v2.0. See the file "LICENSE" for more
	* information.
	*/

	/*
	* 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);
	}


	/*
	* 'backendLookup()' - Lookup the given host and log addresses.
	*/

	http_addrlist_t * /* O - List of addresses or NULL */
	backendLookup(const char hostname, / I - Hostname */
	int port, /* I - Port number */
	int cancel) / I - Variable to watch for job cancel */
	{
	char portname[32], /* Port number as string */
	addrname[256]; /* Address as string */
	http_addrlist_t addrlist, / List of addresses */
	current; / Current address */


	/*
	* Lookup the address for the named host...
	*/

	snprintf(portname, sizeof(portname), "%d", port);

	fputs("STATE: +connecting-to-device\n", stderr);
	fprintf(stderr, "DEBUG: Looking up \"%s\"...\n", hostname);

	while ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL)
	{
	_cupsLangPrintFilter(stderr, "INFO", _("Unable to locate printer \"%s\"."), hostname);
	sleep(10);

	if (getenv("CLASS") != NULL)
	{
	fputs("STATE: -connecting-to-device\n", stderr);
	exit(CUPS_BACKEND_STOP);
	}

	if (cancel && *cancel)
	{
	fputs("STATE: -connecting-to-device\n", stderr);
	exit(CUPS_BACKEND_OK);
	}
	}

	fputs("STATE: -connecting-to-device\n", stderr);

	/*
	* Log the addresses we got...
	*/

	for (current = addrlist; current; current = current->next)
	fprintf(stderr, "DEBUG: %s=%s\n", hostname, httpAddrString(&current->addr, addrname, sizeof(addrname)));

	/*
	* Return...
	*/

	return (addrlist);
	}


	/*
	* '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 += (int)strlen(dataptr);
	break;

	case CUPS_ASN1_INTEGER :
	snprintf(dataptr, sizeof(data) - (size_t)(dataptr - data), "%d",
	packet.object_value.integer);
	datalen += (int)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 += (int)i;
	break;

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

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

	case CUPS_ASN1_TIMETICKS :
	snprintf(dataptr, sizeof(data) - (size_t)(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_CONNECTED :
	status = CUPS_SC_STATUS_OK;
	data[0] = device_fd != -1;
	datalen = 1;
	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));
	}