backend/network.c

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