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

/*
 * "$Id: socket.c 181 2006-06-22 20:01:18Z jlovell $"
 *
 *   AppSocket backend for the Common UNIX Printing System (CUPS).
 *
 *   Copyright 1997-2006 by Easy Software Products, all rights reserved.
 *
 *   These coded instructions, statements, and computer programs are the
 *   property of Easy Software Products and are protected by Federal
 *   copyright law.  Distribution and use rights are outlined in the file
 *   "LICENSE" which should have been included with this file.  If this
 *   file is missing or damaged please contact Easy Software Products
 *   at:
 *
 *       Attn: CUPS Licensing Information
 *       Easy Software Products
 *       44141 Airport View Drive, Suite 204
 *       Hollywood, Maryland 20636 USA
 *
 *       Voice: (301) 373-9600
 *       EMail: cups-info@cups.org
 *         WWW: http://www.cups.org
 *
 *   This file is subject to the Apple OS-Developed Software exception.
 *
 * Contents:
 *
 *   main() - Send a file to the printer or server.
 */

/*
 * Include necessary headers.
 */

#include <cups/http-private.h>
#include "backend-private.h"
#include <stdarg.h>
#include <sys/types.h>
#include <sys/stat.h>

#ifdef WIN32
#  include <winsock.h>
#else
#  include <unistd.h>
#  include <fcntl.h>
#  include <sys/socket.h>
#  include <netinet/in.h>
#  include <arpa/inet.h>
#  include <netdb.h>
#endif /* WIN32 */


/*
 * 'main()' - Send a file to the printer or server.
 *
 * Usage:
 *
 *    printer-uri job-id user title copies options [file]
 */

int					/* O - Exit status */
main(int  argc,				/* I - Number of command-line arguments (6 or 7) */
     char *argv[])			/* I - Command-line arguments */
{
  char		method[255],		/* Method in URI */
		hostname[1024],		/* Hostname */
		username[255],		/* Username info (not used) */
		resource[1024],		/* Resource info (not used) */
		*options,		/* Pointer to options */
		name[255],		/* Name of option */
		value[255],		/* Value of option */
		*ptr;			/* Pointer into name or value */
  int		print_fd;		/* Print file */
  int		copies;			/* Number of copies to print */
  int		waiteof;		/* Wait for end-of-file? */
  int		port;			/* Port number */
  char		portname[255];		/* Port name */
  int		delay;			/* Delay for retries... */
  int		device_fd;		/* AppSocket */
  int		error;			/* Error code (if any) */
  http_addrlist_t *addrlist;		/* Address list */
  ssize_t	tbytes;			/* Total number of bytes written */
  struct timeval timeout;		/* Timeout for select() */
  fd_set	input;			/* Input set for select() */
  ssize_t	bc_bytes;		/* Number of back-channel bytes read */
#if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
  struct sigaction action;		/* Actions for POSIX signals */
#endif /* HAVE_SIGACTION && !HAVE_SIGSET */


 /*
  * Make sure status messages are not buffered...
  */

  setbuf(stderr, NULL);

 /*
  * Ignore SIGPIPE signals...
  */

#ifdef HAVE_SIGSET
  sigset(SIGPIPE, SIG_IGN);
#elif defined(HAVE_SIGACTION)
  memset(&action, 0, sizeof(action));
  action.sa_handler = SIG_IGN;
  sigaction(SIGPIPE, &action, NULL);
#else
  signal(SIGPIPE, SIG_IGN);
#endif /* HAVE_SIGSET */

 /*
  * Check command-line...
  */

  if (argc == 1)
  {
    puts("network socket \"Unknown\" \"AppSocket/HP JetDirect\"");
    return (CUPS_BACKEND_OK);
  }
  else if (argc < 6 || argc > 7)
  {
    fprintf(stderr, "Usage: %s job-id user title copies options [file]\n",
            argv[0]);
    return (CUPS_BACKEND_FAILED);
  }

 /*
  * If we have 7 arguments, print the file named on the command-line.
  * Otherwise, send stdin instead...
  */

  if (argc == 6)
  {
    print_fd = 0;
    copies   = 1;
  }
  else
  {
   /*
    * Try to open the print file...
    */

    if ((print_fd = open(argv[6], O_RDONLY)) < 0)
    {
      perror("ERROR: unable to open print file");
      return (CUPS_BACKEND_FAILED);
    }

    copies = atoi(argv[4]);
  }

 /*
  * Extract the hostname and port number from the URI...
  */

  httpSeparateURI(HTTP_URI_CODING_ALL, cupsBackendDeviceURI(argv),
                  method, sizeof(method), username, sizeof(username),
		  hostname, sizeof(hostname), &port,
		  resource, sizeof(resource));

  if (port == 0)
    port = 9100;	/* Default to HP JetDirect/Tektronix PhaserShare */

 /*
  * Get options, if any...
  */

  waiteof = 1;

  if ((options = strchr(resource, '?')) != NULL)
  {
   /*
    * Yup, terminate the device name string and move to the first
    * character of the options...
    */

    *options++ = '\0';

   /*
    * Parse options...
    */

    while (*options)
    {
     /*
      * Get the name...
      */

      for (ptr = name; *options && *options != '=';)
        if (ptr < (name + sizeof(name) - 1))
          *ptr++ = *options++;
      *ptr = '\0';

      if (*options == '=')
      {
       /*
        * Get the value...
	*/

        options ++;

	for (ptr = value; *options && *options != '+' && *options != '&';)
          if (ptr < (value + sizeof(value) - 1))
            *ptr++ = *options++;
	*ptr = '\0';

	if (*options == '+' || *options == '&')
	  options ++;
      }
      else
        value[0] = '\0';

     /*
      * Process the option...
      */

      if (!strcasecmp(name, "waiteof"))
      {
       /*
        * Set the wait-for-eof value...
	*/

        waiteof = !value[0] || !strcasecmp(value, "on") ||
		  !strcasecmp(value, "yes") || !strcasecmp(value, "true");
      }
    }
  }

 /*
  * Then try to connect to the remote host...
  */

  sprintf(portname, "%d", port);

  if ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL)
  {
    fprintf(stderr, "ERROR: Unable to locate printer \'%s\'!\n", hostname);
    return (CUPS_BACKEND_STOP);
  }

  fprintf(stderr, "INFO: Attempting to connect to host %s on port %d\n",
          hostname, port);

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

  for (delay = 5;;)
  {
    if (!httpAddrConnect(addrlist, &device_fd))
    {
      error     = errno;
      device_fd = -1;

      if (getenv("CLASS") != NULL)
      {
       /*
        * If the CLASS environment variable is set, the job was submitted
	* to a class and not to a specific queue.  In this case, we want
	* to abort immediately so that the job can be requeued on the next
	* available printer in the class.
	*/

        fprintf(stderr, "INFO: Unable to connect to \"%s\", queuing on next printer in class...\n",
		hostname);

       /*
        * Sleep 5 seconds to keep the job from requeuing too rapidly...
	*/

	sleep(5);

        return (CUPS_BACKEND_FAILED);
      }

      if (error == ECONNREFUSED || error == EHOSTDOWN ||
          error == EHOSTUNREACH)
      {
	fprintf(stderr,
	        "INFO: Network host \'%s\' is busy; will retry in %d seconds...\n",
                hostname, delay);
	sleep(delay);

	if (delay < 30)
	  delay += 5;
      }
      else
      {
	perror("ERROR: Unable to connect to printer (retrying in 30 seconds)");
	sleep(30);
      }
    }
    else
      break;
  }

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

 /*
  * Print everything...
  */

  tbytes = 0;

  while (copies > 0 && tbytes >= 0)
  {
    copies --;

    if (print_fd != 0)
    {
      fputs("PAGE: 1 1\n", stderr);
      lseek(print_fd, 0, SEEK_SET);
    }

    tbytes = backendRunLoop(print_fd, device_fd, 1);

    if (print_fd != 0 && tbytes >= 0)
      fprintf(stderr, "INFO: Sent print file, " CUPS_LLFMT " bytes...\n",
	      CUPS_LLCAST tbytes);
  }

  if (waiteof)
  {
   /*
    * Shutdown the socket and wait for the other end to finish...
    */

    fputs("INFO: Print file sent, waiting for printer to finish...\n", stderr);

    shutdown(device_fd, 1);

    for (;;)
    {
     /*
      * Wait a maximum of 90 seconds for backchannel data or a closed
      * connection...
      */

      timeout.tv_sec  = 90;
      timeout.tv_usec = 0;

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

#ifdef __hpux
      if (select(device_fd + 1, (int *)&input, NULL, NULL, &timeout) > 0)
#else
      if (select(device_fd + 1, &input, NULL, NULL, &timeout) > 0)
#endif /* __hpux */
      {
       /*
	* Grab the data coming back and spit it out to stderr...
	*/

	if ((bc_bytes = read(device_fd, resource, sizeof(resource))) > 0)
	{
	  fprintf(stderr, "DEBUG: Received %d bytes of back-channel data!\n",
		  (int)bc_bytes);
	  cupsBackChannelWrite(resource, bc_bytes, 1.0);
	}
	else
	  break;
      }
      else
	break;
    }
  }

 /*
  * Close the socket connection...
  */

  close(device_fd);

  httpAddrFreeList(addrlist);

 /*
  * Close the input file and return...
  */

  if (print_fd != 0)
    close(print_fd);

  if (tbytes >= 0)
    fputs("INFO: Ready to print.\n", stderr);

  return (tbytes < 0 ? CUPS_BACKEND_FAILED : CUPS_BACKEND_OK);
}


/*
 * End of "$Id: socket.c 181 2006-06-22 20:01:18Z jlovell $".
 */
Commit	Line	Data
ef416fc2	1	/*
c07d5b2d	2	* "$Id: socket.c 181 2006-06-22 20:01:18Z jlovell $"
ef416fc2	3	*
	4	* AppSocket backend for the Common UNIX Printing System (CUPS).
	5	*
	6	* Copyright 1997-2006 by Easy Software Products, all rights reserved.
	7	*
	8	* These coded instructions, statements, and computer programs are the
	9	* property of Easy Software Products and are protected by Federal
	10	* copyright law. Distribution and use rights are outlined in the file
	11	* "LICENSE" which should have been included with this file. If this
	12	* file is missing or damaged please contact Easy Software Products
	13	* at:
	14	*
	15	* Attn: CUPS Licensing Information
	16	* Easy Software Products
	17	* 44141 Airport View Drive, Suite 204
	18	* Hollywood, Maryland 20636 USA
	19	*
	20	* Voice: (301) 373-9600
	21	* EMail: cups-info@cups.org
	22	* WWW: http://www.cups.org
	23	*
	24	* This file is subject to the Apple OS-Developed Software exception.
	25	*
	26	* Contents:
	27	*
	28	* main() - Send a file to the printer or server.
	29	*/
	30
	31	/*
	32	* Include necessary headers.
	33	*/
	34
ef416fc2	35	#include <cups/http-private.h>
ed486911	36	#include "backend-private.h"
ef416fc2	37	#include <stdarg.h>
ef416fc2	38	#include <sys/types.h>
ef416fc2	39	#include <sys/stat.h>
ef416fc2	40
	41	#ifdef WIN32
	42	# include <winsock.h>
	43	#else
	44	# include <unistd.h>
	45	# include <fcntl.h>
	46	# include <sys/socket.h>
	47	# include <netinet/in.h>
	48	# include <arpa/inet.h>
	49	# include <netdb.h>
	50	#endif /* WIN32 */
	51
	52
	53	/*
	54	* 'main()' - Send a file to the printer or server.
	55	*
	56	* Usage:
	57	*
	58	* printer-uri job-id user title copies options [file]
	59	*/
	60
	61	int /* O - Exit status */
	62	main(int argc, /* I - Number of command-line arguments (6 or 7) */
	63	char argv[]) / I - Command-line arguments */
	64	{
	65	char method[255], /* Method in URI */
	66	hostname[1024], /* Hostname */
	67	username[255], /* Username info (not used) */
fa73b229	68	resource[1024], /* Resource info (not used) */
	69	options, / Pointer to options */
	70	name[255], /* Name of option */
	71	value[255], /* Value of option */
	72	ptr; / Pointer into name or value */
ed486911	73	int print_fd; /* Print file */
ef416fc2	74	int copies; /* Number of copies to print */
fa73b229	75	int waiteof; /* Wait for end-of-file? */
ef416fc2	76	int port; /* Port number */
	77	char portname[255]; /* Port name */
	78	int delay; /* Delay for retries... */
ed486911	79	int device_fd; /* AppSocket */
ef416fc2	80	int error; /* Error code (if any) */
ef416fc2	81	http_addrlist_t addrlist; / Address list */
ed486911	82	ssize_t tbytes; /* Total number of bytes written */
ef416fc2	83	struct timeval timeout; /* Timeout for select() */
ed486911	84	fd_set input; /* Input set for select() */
ed486911	85	ssize_t bc_bytes; /* Number of back-channel bytes read */
ef416fc2	86	#if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
	87	struct sigaction action; /* Actions for POSIX signals */
	88	#endif /* HAVE_SIGACTION && !HAVE_SIGSET */
	89
	90
	91	/*
	92	* Make sure status messages are not buffered...
	93	*/
	94
	95	setbuf(stderr, NULL);
	96
	97	/*
	98	* Ignore SIGPIPE signals...
	99	*/
	100
	101	#ifdef HAVE_SIGSET
	102	sigset(SIGPIPE, SIG_IGN);
	103	#elif defined(HAVE_SIGACTION)
	104	memset(&action, 0, sizeof(action));
	105	action.sa_handler = SIG_IGN;
	106	sigaction(SIGPIPE, &action, NULL);
	107	#else
	108	signal(SIGPIPE, SIG_IGN);
	109	#endif /* HAVE_SIGSET */
	110
	111	/*
	112	* Check command-line...
	113	*/
	114
	115	if (argc == 1)
	116	{
	117	puts("network socket \"Unknown\" \"AppSocket/HP JetDirect\"");
	118	return (CUPS_BACKEND_OK);
	119	}
	120	else if (argc < 6 \|\| argc > 7)
	121	{
	122	fprintf(stderr, "Usage: %s job-id user title copies options [file]\n",
	123	argv[0]);
	124	return (CUPS_BACKEND_FAILED);
	125	}
	126
	127	/*
	128	* If we have 7 arguments, print the file named on the command-line.
	129	* Otherwise, send stdin instead...
	130	*/
	131
	132	if (argc == 6)
	133	{
ed486911	134	print_fd = 0;
ed486911	135	copies = 1;
ef416fc2	136	}
	137	else
	138	{
	139	/*
	140	* Try to open the print file...
	141	*/
	142
ed486911	143	if ((print_fd = open(argv[6], O_RDONLY)) < 0)
ef416fc2	144	{
	145	perror("ERROR: unable to open print file");
	146	return (CUPS_BACKEND_FAILED);
	147	}
	148
	149	copies = atoi(argv[4]);
	150	}
	151
	152	/*
	153	* Extract the hostname and port number from the URI...
	154	*/
	155
a4d04587	156	httpSeparateURI(HTTP_URI_CODING_ALL, cupsBackendDeviceURI(argv),
	157	method, sizeof(method), username, sizeof(username),
	158	hostname, sizeof(hostname), &port,
ef416fc2	159	resource, sizeof(resource));
	160
	161	if (port == 0)
	162	port = 9100; /* Default to HP JetDirect/Tektronix PhaserShare */
	163
fa73b229	164	/*
	165	* Get options, if any...
	166	*/
	167
	168	waiteof = 1;
	169
	170	if ((options = strchr(resource, '?')) != NULL)
	171	{
	172	/*
	173	* Yup, terminate the device name string and move to the first
	174	* character of the options...
	175	*/
	176
	177	*options++ = '\0';
	178
	179	/*
	180	* Parse options...
	181	*/
	182
	183	while (*options)
	184	{
	185	/*
	186	* Get the name...
	187	*/
	188
	189	for (ptr = name; options && options != '=';)
	190	if (ptr < (name + sizeof(name) - 1))
	191	ptr++ = options++;
	192	*ptr = '\0';
	193
	194	if (*options == '=')
	195	{
	196	/*
	197	* Get the value...
	198	*/
	199
	200	options ++;
	201
	202	for (ptr = value; options && options != '+' && *options != '&';)
	203	if (ptr < (value + sizeof(value) - 1))
	204	ptr++ = options++;
	205	*ptr = '\0';
	206
	207	if (options == '+' \|\| options == '&')
	208	options ++;
	209	}
	210	else
	211	value[0] = '\0';
	212
	213	/*
	214	* Process the option...
	215	*/
	216
	217	if (!strcasecmp(name, "waiteof"))
	218	{
	219	/*
	220	* Set the wait-for-eof value...
	221	*/
	222
	223	waiteof = !value[0] \|\| !strcasecmp(value, "on") \|\|
	224	!strcasecmp(value, "yes") \|\| !strcasecmp(value, "true");
	225	}
	226	}
	227	}
228
ef416fc2	229	/*
	230	* Then try to connect to the remote host...
	231	*/
	232
	233	sprintf(portname, "%d", port);
	234
	235	if ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL)
	236	{
	237	fprintf(stderr, "ERROR: Unable to locate printer \'%s\'!\n", hostname);
	238	return (CUPS_BACKEND_STOP);
	239	}
	240
	241	fprintf(stderr, "INFO: Attempting to connect to host %s on port %d\n",
	242	hostname, port);
	243
ed486911	244	fputs("STATE: +connecting-to-device\n", stderr);
ef416fc2	245
ed486911	246	for (delay = 5;;)
ef416fc2	247	{
ed486911	248	if (!httpAddrConnect(addrlist, &device_fd))
ef416fc2	249	{
ed486911	250	error = errno;
ed486911	251	device_fd = -1;
ef416fc2	252
ed486911	253	if (getenv("CLASS") != NULL)
	254	{
	255	/*
	256	* If the CLASS environment variable is set, the job was submitted
	257	* to a class and not to a specific queue. In this case, we want
	258	* to abort immediately so that the job can be requeued on the next
	259	* available printer in the class.
	260	*/
ef416fc2	261
ed486911	262	fprintf(stderr, "INFO: Unable to connect to \"%s\", queuing on next printer in class...\n",
ed486911	263	hostname);
ef416fc2	264
ed486911	265	/*
	266	* Sleep 5 seconds to keep the job from requeuing too rapidly...
	267	*/
ef416fc2	268
ed486911	269	sleep(5);
ef416fc2	270
ed486911	271	return (CUPS_BACKEND_FAILED);
ed486911	272	}
ef416fc2	273
ed486911	274	if (error == ECONNREFUSED \|\| error == EHOSTDOWN \|\|
	275	error == EHOSTUNREACH)
	276	{
	277	fprintf(stderr,
	278	"INFO: Network host \'%s\' is busy; will retry in %d seconds...\n",
	279	hostname, delay);
	280	sleep(delay);
ef416fc2	281
ed486911	282	if (delay < 30)
ed486911	283	delay += 5;
ef416fc2	284	}
ef416fc2	285	else
ed486911	286	{
	287	perror("ERROR: Unable to connect to printer (retrying in 30 seconds)");
	288	sleep(30);
	289	}
ef416fc2	290	}
ed486911	291	else
	292	break;
	293	}
ef416fc2	294
ed486911	295	fputs("STATE: -connecting-to-device\n", stderr);
ef416fc2	296
ed486911	297	/*
	298	* Print everything...
	299	*/
ef416fc2	300
ed486911	301	tbytes = 0;
ef416fc2	302
ed486911	303	while (copies > 0 && tbytes >= 0)
ed486911	304	{
ef416fc2	305	copies --;
ef416fc2	306
ed486911	307	if (print_fd != 0)
ef416fc2	308	{
ef416fc2	309	fputs("PAGE: 1 1\n", stderr);
ed486911	310	lseek(print_fd, 0, SEEK_SET);
ef416fc2	311	}
ef416fc2	312
ed486911	313	tbytes = backendRunLoop(print_fd, device_fd, 1);
ef416fc2	314
ed486911	315	if (print_fd != 0 && tbytes >= 0)
	316	fprintf(stderr, "INFO: Sent print file, " CUPS_LLFMT " bytes...\n",
	317	CUPS_LLCAST tbytes);
	318	}
ef416fc2	319
ed486911	320	if (waiteof)
	321	{
	322	/*
	323	* Shutdown the socket and wait for the other end to finish...
	324	*/
ef416fc2	325
ed486911	326	fputs("INFO: Print file sent, waiting for printer to finish...\n", stderr);
ef416fc2	327
ed486911	328	shutdown(device_fd, 1);
ef416fc2	329
ed486911	330	for (;;)
ef416fc2	331	{
ef416fc2	332	/*
ed486911	333	* Wait a maximum of 90 seconds for backchannel data or a closed
ed486911	334	* connection...
ef416fc2	335	*/
ef416fc2	336
ed486911	337	timeout.tv_sec = 90;
ed486911	338	timeout.tv_usec = 0;
ef416fc2	339
ed486911	340	FD_ZERO(&input);
ed486911	341	FD_SET(device_fd, &input);
ef416fc2	342
ed486911	343	#ifdef __hpux
	344	if (select(device_fd + 1, (int *)&input, NULL, NULL, &timeout) > 0)
	345	#else
	346	if (select(device_fd + 1, &input, NULL, NULL, &timeout) > 0)
	347	#endif /* __hpux */
ef416fc2	348	{
ef416fc2	349	/*
ed486911	350	* Grab the data coming back and spit it out to stderr...
ef416fc2	351	*/
ef416fc2	352
ed486911	353	if ((bc_bytes = read(device_fd, resource, sizeof(resource))) > 0)
ef416fc2	354	{
ed486911	355	fprintf(stderr, "DEBUG: Received %d bytes of back-channel data!\n",
	356	(int)bc_bytes);
	357	cupsBackChannelWrite(resource, bc_bytes, 1.0);
fa73b229	358	}
ef416fc2	359	else
	360	break;
	361	}
ed486911	362	else
ed486911	363	break;
ef416fc2	364	}
ed486911	365	}
ef416fc2	366
ed486911	367	/*
	368	* Close the socket connection...
	369	*/
ef416fc2	370
ed486911	371	close(device_fd);
ef416fc2	372
	373	httpAddrFreeList(addrlist);
	374
	375	/*
	376	* Close the input file and return...
	377	*/
	378
ed486911	379	if (print_fd != 0)
ed486911	380	close(print_fd);
ef416fc2	381
ed486911	382	if (tbytes >= 0)
ef416fc2	383	fputs("INFO: Ready to print.\n", stderr);
ef416fc2	384
ed486911	385	return (tbytes < 0 ? CUPS_BACKEND_FAILED : CUPS_BACKEND_OK);
ef416fc2	386	}
	387
	388
	389	/*
c07d5b2d	390	* End of "$Id: socket.c 181 2006-06-22 20:01:18Z jlovell $".
ef416fc2	391	*/