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