backend/socket.c

   1 /*
   2  * "$Id: socket.c 7881 2008-08-28 20:21:56Z mike $"
   3  *
   4  *   AppSocket backend for the Common UNIX Printing System (CUPS).
   5  *
   6  *   Copyright 2007-2010 by Apple Inc.
   7  *   Copyright 1997-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
  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  *
  19  *   main()    - Send a file to the printer or server.
  20  *   wait_bc() - Wait for back-channel data...
  21  */
  22
  23 /*
  24  * Include necessary headers.
  25  */
  26
  27 #include <cups/http-private.h>
  28 #include "backend-private.h"
  29 #include <stdarg.h>
  30 #include <sys/types.h>
  31 #include <sys/stat.h>
  32
  33 #ifdef WIN32
  34 #  include <winsock.h>
  35 #else
  36 #  include <unistd.h>
  37 #  include <fcntl.h>
  38 #  include <sys/socket.h>
  39 #  include <netinet/in.h>
  40 #  include <arpa/inet.h>
  41 #  include <netdb.h>
  42 #endif /* WIN32 */
  43
  44
  45 /*
  46  * Local functions...
  47  */
  48
  49 static int      wait_bc(int device_fd, int secs);
  50
  51
  52 /*
  53  * 'main()' - Send a file to the printer or server.
  54  *
  55  * Usage:
  56  *
  57  *    printer-uri job-id user title copies options [file]
  58  */
  59
  60 int                                     /* O - Exit status */
  61 main(int  argc,                         /* I - Number of command-line arguments (6 or 7) */
  62      char *argv[])                      /* I - Command-line arguments */
  63 {
  64   const char    *device_uri;            /* Device URI */
  65   char          scheme[255],            /* Scheme in URI */
  66                 hostname[1024],         /* Hostname */
  67                 username[255],          /* Username info (not used) */
  68                 resource[1024],         /* Resource info (not used) */
  69                 *options,               /* Pointer to options */
  70                 *name,                  /* Name of option */
  71                 *value,                 /* Value of option */
  72                 sep;                    /* Option separator */
  73   int           print_fd;               /* Print file */
  74   int           copies;                 /* Number of copies to print */
  75   time_t        start_time;             /* Time of first connect */
  76 #ifdef __APPLE__
  77   time_t        current_time,           /* Current time */
  78                 wait_time;              /* Time to wait before shutting down socket */
  79 #endif /* __APPLE__ */
  80   int           contimeout;             /* Connection timeout */
  81   int           waiteof;                /* Wait for end-of-file? */
  82   int           port;                   /* Port number */
  83   char          portname[255];          /* Port name */
  84   int           delay;                  /* Delay for retries... */
  85   int           device_fd;              /* AppSocket */
  86   int           error;                  /* Error code (if any) */
  87   http_addrlist_t *addrlist,            /* Address list */
  88                 *addr;                  /* Connected address */
  89   char          addrname[256];          /* Address name */
  90   int           snmp_fd,                /* SNMP socket */
  91                 start_count,            /* Page count via SNMP at start */
  92                 page_count,             /* Page count via SNMP */
  93                 have_supplies;          /* Printer supports supply levels? */
  94   ssize_t       tbytes;                 /* Total number of bytes written */
  95 #if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
  96   struct sigaction action;              /* Actions for POSIX signals */
  97 #endif /* HAVE_SIGACTION && !HAVE_SIGSET */
  98
  99
 100  /*
 101   * Make sure status messages are not buffered...
 102   */
 103
 104   setbuf(stderr, NULL);
 105
 106  /*
 107   * Ignore SIGPIPE signals...
 108   */
 109
 110 #ifdef HAVE_SIGSET
 111   sigset(SIGPIPE, SIG_IGN);
 112 #elif defined(HAVE_SIGACTION)
 113   memset(&action, 0, sizeof(action));
 114   action.sa_handler = SIG_IGN;
 115   sigaction(SIGPIPE, &action, NULL);
 116 #else
 117   signal(SIGPIPE, SIG_IGN);
 118 #endif /* HAVE_SIGSET */
 119
 120  /*
 121   * Check command-line...
 122   */
 123
 124   if (argc == 1)
 125   {
 126     printf("network socket \"Unknown\" \"%s\"\n",
 127            _cupsLangString(cupsLangDefault(), _("AppSocket/HP JetDirect")));
 128     return (CUPS_BACKEND_OK);
 129   }
 130   else if (argc < 6 || argc > 7)
 131   {
 132     _cupsLangPrintf(stderr,
 133                     _("Usage: %s job-id user title copies options [file]\n"),
 134                     argv[0]);
 135     return (CUPS_BACKEND_FAILED);
 136   }
 137
 138  /*
 139   * If we have 7 arguments, print the file named on the command-line.
 140   * Otherwise, send stdin instead...
 141   */
 142
 143   if (argc == 6)
 144   {
 145     print_fd = 0;
 146     copies   = 1;
 147   }
 148   else
 149   {
 150    /*
 151     * Try to open the print file...
 152     */
 153
 154     if ((print_fd = open(argv[6], O_RDONLY)) < 0)
 155     {
 156       _cupsLangPrintf(stderr,
 157                       _("ERROR: Unable to open print file \"%s\": %s\n"),
 158                       argv[6], strerror(errno));
 159       return (CUPS_BACKEND_FAILED);
 160     }
 161
 162     copies = atoi(argv[4]);
 163   }
 164
 165  /*
 166   * Extract the hostname and port number from the URI...
 167   */
 168
 169   if ((device_uri = cupsBackendDeviceURI(argv)) == NULL)
 170     return (CUPS_BACKEND_FAILED);
 171
 172   httpSeparateURI(HTTP_URI_CODING_ALL, device_uri, scheme, sizeof(scheme),
 173                   username, sizeof(username), hostname, sizeof(hostname), &port,
 174                   resource, sizeof(resource));
 175
 176   if (port == 0)
 177     port = 9100;        /* Default to HP JetDirect/Tektronix PhaserShare */
 178
 179  /*
 180   * Get options, if any...
 181   */
 182
 183   waiteof    = 1;
 184   contimeout = 7 * 24 * 60 * 60;
 185
 186   if ((options = strchr(resource, '?')) != NULL)
 187   {
 188    /*
 189     * Yup, terminate the device name string and move to the first
 190     * character of the options...
 191     */
 192
 193     *options++ = '\0';
 194
 195    /*
 196     * Parse options...
 197     */
 198
 199     while (*options)
 200     {
 201      /*
 202       * Get the name...
 203       */
 204
 205       name = options;
 206
 207       while (*options && *options != '=' && *options != '+' && *options != '&')
 208         options ++;
 209
 210       if ((sep = *options) != '\0')
 211         *options++ = '\0';
 212
 213       if (sep == '=')
 214       {
 215        /*
 216         * Get the value...
 217         */
 218
 219         value = options;
 220
 221         while (*options && *options != '+' && *options != '&')
 222           options ++;
 223
 224         if (*options)
 225           *options++ = '\0';
 226       }
 227       else
 228         value = (char *)"";
 229
 230      /*
 231       * Process the option...
 232       */
 233
 234       if (!strcasecmp(name, "waiteof"))
 235       {
 236        /*
 237         * Set the wait-for-eof value...
 238         */
 239
 240         waiteof = !value[0] || !strcasecmp(value, "on") ||
 241                   !strcasecmp(value, "yes") || !strcasecmp(value, "true");
 242       }
 243       else if (!strcasecmp(name, "contimeout"))
 244       {
 245        /*
 246         * Set the connection timeout...
 247         */
 248
 249         if (atoi(value) > 0)
 250           contimeout = atoi(value);
 251       }
 252     }
 253   }
 254
 255  /*
 256   * Then try to connect to the remote host...
 257   */
 258
 259   start_time = time(NULL);
 260
 261   sprintf(portname, "%d", port);
 262
 263   fputs("STATE: +connecting-to-device\n", stderr);
 264   fprintf(stderr, "DEBUG: Looking up \"%s\"...\n", hostname);
 265
 266   if ((addrlist = httpAddrGetList(hostname, AF_UNSPEC, portname)) == NULL)
 267   {
 268     _cupsLangPrintf(stderr, _("ERROR: Unable to locate printer \'%s\'\n"),
 269                     hostname);
 270     return (CUPS_BACKEND_STOP);
 271   }
 272
 273   fprintf(stderr, "DEBUG: Connecting to %s:%d\n", hostname, port);
 274   _cupsLangPuts(stderr, _("INFO: Connecting to printer...\n"));
 275
 276   for (delay = 5;;)
 277   {
 278     if ((addr = httpAddrConnect(addrlist, &device_fd)) == NULL)
 279     {
 280       error     = errno;
 281       device_fd = -1;
 282
 283       if (getenv("CLASS") != NULL)
 284       {
 285        /*
 286         * If the CLASS environment variable is set, the job was submitted
 287         * to a class and not to a specific queue.  In this case, we want
 288         * to abort immediately so that the job can be requeued on the next
 289         * available printer in the class.
 290         */
 291
 292         _cupsLangPuts(stderr,
 293                       _("INFO: Unable to contact printer, queuing on next "
 294                         "printer in class...\n"));
 295
 296        /*
 297         * Sleep 5 seconds to keep the job from requeuing too rapidly...
 298         */
 299
 300         sleep(5);
 301
 302         return (CUPS_BACKEND_FAILED);
 303       }
 304
 305       if (error == ECONNREFUSED || error == EHOSTDOWN ||
 306           error == EHOSTUNREACH)
 307       {
 308         if (contimeout && (time(NULL) - start_time) > contimeout)
 309         {
 310           _cupsLangPuts(stderr, _("ERROR: Printer not responding\n"));
 311           return (CUPS_BACKEND_FAILED);
 312         }
 313
 314         _cupsLangPrintf(stderr,
 315                         _("WARNING: Network host \'%s\' is busy; will retry in "
 316                           "%d seconds...\n"), hostname, delay);
 317
 318         sleep(delay);
 319
 320         if (delay < 30)
 321           delay += 5;
 322       }
 323       else
 324       {
 325         _cupsLangPrintf(stderr, "DEBUG: Connection error: %s\n",
 326                         strerror(errno));
 327         _cupsLangPuts(stderr,
 328                       _("ERROR: Unable to connect to printer; will retry in 30 "
 329                         "seconds...\n"));
 330         sleep(30);
 331       }
 332     }
 333     else
 334       break;
 335   }
 336
 337   fputs("STATE: -connecting-to-device\n", stderr);
 338   _cupsLangPuts(stderr, _("INFO: Connected to printer...\n"));
 339
 340 #ifdef AF_INET6
 341   if (addr->addr.addr.sa_family == AF_INET6)
 342     fprintf(stderr, "DEBUG: Connected to [%s]:%d (IPv6)...\n",
 343             httpAddrString(&addr->addr, addrname, sizeof(addrname)),
 344             ntohs(addr->addr.ipv6.sin6_port));
 345   else
 346 #endif /* AF_INET6 */
 347     if (addr->addr.addr.sa_family == AF_INET)
 348       fprintf(stderr, "DEBUG: Connected to %s:%d (IPv4)...\n",
 349               httpAddrString(&addr->addr, addrname, sizeof(addrname)),
 350               ntohs(addr->addr.ipv4.sin_port));
 351
 352  /*
 353   * See if the printer supports SNMP...
 354   */
 355
 356   if ((snmp_fd = _cupsSNMPOpen(addr->addr.addr.sa_family)) >= 0)
 357   {
 358     have_supplies = !backendSNMPSupplies(snmp_fd, &(addr->addr), &start_count,
 359                                          NULL);
 360   }
 361   else
 362     have_supplies = start_count = 0;
 363
 364  /*
 365   * Print everything...
 366   */
 367
 368   tbytes = 0;
 369
 370   while (copies > 0 && tbytes >= 0)
 371   {
 372     copies --;
 373
 374     if (print_fd != 0)
 375     {
 376       fputs("PAGE: 1 1\n", stderr);
 377       lseek(print_fd, 0, SEEK_SET);
 378     }
 379
 380     tbytes = backendRunLoop(print_fd, device_fd, snmp_fd, &(addr->addr), 1, 0,
 381                             backendNetworkSideCB);
 382
 383     if (print_fd != 0 && tbytes >= 0)
 384       _cupsLangPrintf(stderr,
 385 #ifdef HAVE_LONG_LONG
 386                       _("INFO: Sent print file, %lld bytes...\n"),
 387 #else
 388                       _("INFO: Sent print file, %ld bytes...\n"),
 389 #endif /* HAVE_LONG_LONG */
 390                       CUPS_LLCAST tbytes);
 391   }
 392
 393 #ifdef __APPLE__
 394  /*
 395   * Wait up to 5 seconds to get any pending back-channel data...
 396   */
 397
 398   wait_time = time(NULL) + 5;
 399   while (wait_time >= time(&current_time))
 400     if (wait_bc(device_fd, wait_time - current_time) <= 0)
 401       break;
 402 #endif /* __APPLE__ */
 403
 404   if (waiteof)
 405   {
 406    /*
 407     * Shutdown the socket and wait for the other end to finish...
 408     */
 409
 410     _cupsLangPuts(stderr,
 411                   _("INFO: Print file sent, waiting for printer to finish...\n"));
 412
 413     shutdown(device_fd, 1);
 414
 415     while (wait_bc(device_fd, 90) > 0);
 416   }
 417
 418  /*
 419   * Collect the final page count as needed...
 420   */
 421
 422   if (have_supplies &&
 423       !backendSNMPSupplies(snmp_fd, &(addr->addr), &page_count, NULL) &&
 424       page_count > start_count)
 425     fprintf(stderr, "PAGE: total %d\n", page_count - start_count);
 426
 427  /*
 428   * Close the socket connection...
 429   */
 430
 431   close(device_fd);
 432
 433   httpAddrFreeList(addrlist);
 434
 435  /*
 436   * Close the input file and return...
 437   */
 438
 439   if (print_fd != 0)
 440     close(print_fd);
 441
 442   if (tbytes >= 0)
 443     _cupsLangPuts(stderr, _("INFO: Ready to print.\n"));
 444
 445   return (tbytes < 0 ? CUPS_BACKEND_FAILED : CUPS_BACKEND_OK);
 446 }
 447
 448
 449 /*
 450  * 'wait_bc()' - Wait for back-channel data...
 451  */
 452
 453 static int                              /* O - # bytes read or -1 on error */
 454 wait_bc(int device_fd,                  /* I - Socket */
 455         int secs)                       /* I - Seconds to wait */
 456 {
 457   struct timeval timeout;               /* Timeout for select() */
 458   fd_set        input;                  /* Input set for select() */
 459   ssize_t       bytes;                  /* Number of back-channel bytes read */
 460   char          buffer[1024];           /* Back-channel buffer */
 461
 462
 463  /*
 464   * Wait up to "secs" seconds for backchannel data...
 465   */
 466
 467   timeout.tv_sec  = secs;
 468   timeout.tv_usec = 0;
 469
 470   FD_ZERO(&input);
 471   FD_SET(device_fd, &input);
 472
 473   if (select(device_fd + 1, &input, NULL, NULL, &timeout) > 0)
 474   {
 475    /*
 476     * Grab the data coming back and spit it out to stderr...
 477     */
 478
 479     if ((bytes = read(device_fd, buffer, sizeof(buffer))) > 0)
 480     {
 481       fprintf(stderr, "DEBUG: Received %d bytes of back-channel data\n",
 482               (int)bytes);
 483       cupsBackChannelWrite(buffer, bytes, 1.0);
 484     }
 485
 486     return (bytes);
 487   }
 488   else
 489     return (-1);
 490 }
 491
 492
 493 /*
 494  * End of "$Id: socket.c 7881 2008-08-28 20:21:56Z mike $".
 495  */