]> git.ipfire.org Git - thirdparty/cups.git/blame - scheduler/cups-deviced.c
Load cups into easysw/current.
[thirdparty/cups.git] / scheduler / cups-deviced.c
CommitLineData
ef416fc2 1/*
bd7854cb 2 * "$Id: cups-deviced.c 5099 2006-02-13 02:46:10Z mike $"
ef416fc2 3 *
4 * Device scanning mini-daemon for the Common UNIX Printing System (CUPS).
5 *
bd7854cb 6 * Copyright 1997-2006 by Easy Software Products.
ef416fc2 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.txt" 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 * Contents:
25 *
26 * main() - Scan for devices and return an IPP response.
27 * add_dev() - Add a new device to the list.
28 * compare_devs() - Compare device names for sorting.
29 * sigalrm_handler() - Handle alarm signals for backends that get hung
30 */
31
32/*
33 * Include necessary headers...
34 */
35
36#include "util.h"
37#include <cups/array.h>
38#include <cups/dir.h>
39
40
41/*
42 * Device information structure...
43 */
44
45typedef struct
46{
47 char device_class[128], /* Device class */
48 device_make_and_model[128], /* Make and model, if known */
49 device_info[128], /* Device info/description */
50 device_uri[1024], /* Device URI */
51 device_id[1024]; /* 1284 Device ID */
52} dev_info_t;
53
54
55/*
56 * Local globals...
57 */
58
59static int alarm_tripped; /* Non-zero if alarm was tripped */
60static cups_array_t *devs; /* Device info */
e00b005a 61static int normal_user; /* Normal user ID */
ef416fc2 62
63
64/*
65 * Local functions...
66 */
67
68static dev_info_t *add_dev(const char *device_class,
69 const char *device_make_and_model,
70 const char *device_info,
71 const char *device_uri,
72 const char *device_id);
73static int compare_devs(dev_info_t *p0, dev_info_t *p1);
74static void sigalrm_handler(int sig);
75
76
77/*
78 * 'main()' - Scan for devices and return an IPP response.
79 *
80 * Usage:
81 *
82 * cups-deviced request_id limit options
83 */
84
85int /* O - Exit code */
86main(int argc, /* I - Number of command-line args */
87 char *argv[]) /* I - Command-line arguments */
88{
89 const char *server_bin; /* CUPS_SERVERBIN environment variable */
90 char backends[1024]; /* Location of backends */
e00b005a 91 int request_id; /* Request ID */
ef416fc2 92 int count; /* Number of devices from backend */
93 int compat; /* Compatibility device? */
94 FILE *fp; /* Pipe to device backend */
95 cups_dir_t *dir; /* Directory pointer */
96 cups_dentry_t *dent; /* Directory entry */
97 char filename[1024], /* Name of backend */
98 line[2048], /* Line from backend */
99 dclass[64], /* Device class */
100 uri[1024], /* Device URI */
101 info[128], /* Device info */
102 make_model[256], /* Make and model */
103 device_id[1024]; /* 1284 device ID */
104 int num_options; /* Number of options */
105 cups_option_t *options; /* Options */
106 const char *requested; /* requested-attributes option */
107 int send_class, /* Send device-class attribute? */
108 send_info, /* Send device-info attribute? */
109 send_make_and_model, /* Send device-make-and-model attribute? */
110 send_uri, /* Send device-uri attribute? */
111 send_id; /* Send device-id attribute? */
112 dev_info_t *dev; /* Current device */
113#if defined(HAVE_SIGACTION) && !defined(HAVE_SIGSET)
114 struct sigaction action; /* Actions for POSIX signals */
115#endif /* HAVE_SIGACTION && !HAVE_SIGSET */
116
117
e00b005a 118 setbuf(stderr, NULL);
119
ef416fc2 120 /*
121 * Check the command-line...
122 */
123
e00b005a 124 if (argc > 1)
125 request_id = atoi(argv[1]);
126 else
127 request_id = 1;
128
129 if (argc != 5)
130 {
131 fputs("Usage: cups-deviced request-id limit user-id options\n", stderr);
132
e00b005a 133 return (1);
134 }
135
136 if (request_id < 1)
ef416fc2 137 {
e00b005a 138 fprintf(stderr, "cups-deviced: Bad request ID %d!\n", request_id);
139
ef416fc2 140 return (1);
141 }
142
e00b005a 143 normal_user = atoi(argv[3]);
144 if (normal_user <= 0)
145 {
146 fprintf(stderr, "cups-deviced: Bad user %d!\n", normal_user);
147
e00b005a 148 return (1);
149 }
150
151 num_options = cupsParseOptions(argv[4], 0, &options);
ef416fc2 152 requested = cupsGetOption("requested-attributes", num_options, options);
153
154 if (!requested || strstr(requested, "all"))
155 {
156 send_class = 1;
157 send_info = 1;
158 send_make_and_model = 1;
159 send_uri = 1;
160 send_id = 1;
161 }
162 else
163 {
164 send_class = strstr(requested, "device-class") != NULL;
165 send_info = strstr(requested, "device-info") != NULL;
166 send_make_and_model = strstr(requested, "device-make-and-model") != NULL;
167 send_uri = strstr(requested, "device-uri") != NULL;
168 send_id = strstr(requested, "device-id") != NULL;
169 }
170
171 /*
172 * Try opening the backend directory...
173 */
174
175 if ((server_bin = getenv("CUPS_SERVERBIN")) == NULL)
176 server_bin = CUPS_SERVERBIN;
177
178 snprintf(backends, sizeof(backends), "%s/backend", server_bin);
179
180 if ((dir = cupsDirOpen(backends)) == NULL)
181 {
e00b005a 182 fprintf(stderr, "ERROR: [cups-deviced] Unable to open backend directory "
183 "\"%s\": %s", backends, strerror(errno));
184
ef416fc2 185 return (1);
186 }
187
188 /*
189 * Setup the devices array...
190 */
191
192 devs = cupsArrayNew((cups_array_func_t)compare_devs, NULL);
193
194 /*
195 * Loop through all of the device backends...
196 */
197
198 while ((dent = cupsDirRead(dir)) != NULL)
199 {
e00b005a 200 /*
201 * Skip entries that are not executable files...
202 */
203
204 if (!S_ISREG(dent->fileinfo.st_mode) ||
205 (dent->fileinfo.st_mode & (S_IRUSR | S_IXUSR)) != (S_IRUSR | S_IXUSR))
206 continue;
207
208 /*
209 * Change effective users depending on the backend permissions...
210 */
211
212 if (!getuid())
213 {
214 /*
215 * Backends without permissions for normal users run as root,
216 * all others run as the unprivileged user...
217 */
218
219 if (!(dent->fileinfo.st_mode & (S_IRWXG | S_IRWXO)))
220 seteuid(0);
221 else
222 seteuid(normal_user);
223 }
224
ef416fc2 225 /*
226 * Run the backend with no arguments and collect the output...
227 */
228
229 snprintf(filename, sizeof(filename), "%s/%s", backends, dent->filename);
230 if ((fp = popen(filename, "r")) != NULL)
231 {
232 /*
233 * Set an alarm for the first read from the backend; this avoids
234 * problems when a backend is hung getting device information.
235 */
236
237#ifdef HAVE_SIGSET /* Use System V signals over POSIX to avoid bugs */
238 sigset(SIGALRM, sigalrm_handler);
239#elif defined(HAVE_SIGACTION)
240 memset(&action, 0, sizeof(action));
241
242 sigemptyset(&action.sa_mask);
243 sigaddset(&action.sa_mask, SIGALRM);
244 action.sa_handler = sigalrm_handler;
245 sigaction(SIGALRM, &action, NULL);
246#else
247 signal(SIGALRM, sigalrm_handler);
248#endif /* HAVE_SIGSET */
249
250 alarm_tripped = 0;
251 count = 0;
252 compat = !strcmp(dent->filename, "smb");
253
254 alarm(30);
255
256 while (fgets(line, sizeof(line), fp) != NULL)
257 {
258 /*
259 * Reset the alarm clock...
260 */
261
262 alarm(30);
263
264 /*
265 * Each line is of the form:
266 *
267 * class URI "make model" "name" ["1284 device ID"]
268 */
269
270 device_id[0] = '\0';
271
272 if (!strncasecmp(line, "Usage", 5))
273 compat = 1;
274 else if (sscanf(line,
275 "%63s%1023s%*[ \t]\"%255[^\"]\"%*[ \t]\"%127[^\"]"
276 "%*[ \t]\"%1023[^\"]",
277 dclass, uri, make_model, info, device_id) < 4)
278 {
279 /*
280 * Bad format; strip trailing newline and write an error message.
281 */
282
283 if (line[strlen(line) - 1] == '\n')
284 line[strlen(line) - 1] = '\0';
285
286 fprintf(stderr, "ERROR: [cups-deviced] Bad line from \"%s\": %s\n",
287 dent->filename, line);
288 compat = 1;
289 break;
290 }
291 else
292 {
293 /*
294 * Add the device to the array of available devices...
295 */
296
297 dev = add_dev(dclass, make_model, info, uri, device_id);
298 if (!dev)
299 {
300 cupsDirClose(dir);
301 return (1);
302 }
303
e00b005a 304 fprintf(stderr, "DEBUG: [cups-deviced] Added device \"%s\"...\n",
305 uri);
ef416fc2 306 count ++;
307 }
308 }
309
310 /*
311 * Turn the alarm clock off and close the pipe to the command...
312 */
313
314 alarm(0);
315
316 if (alarm_tripped)
e00b005a 317 fprintf(stderr, "WARNING: [cups-deviced] Backend \"%s\" did not "
318 "respond within 30 seconds!\n", dent->filename);
ef416fc2 319
320 pclose(fp);
321
322 /*
323 * Hack for backends that don't support the CUPS 1.1 calling convention:
324 * add a network device with the method == backend name.
325 */
326
327 if (count == 0 && compat)
328 {
329 snprintf(line, sizeof(line), "Unknown Network Device (%s)",
330 dent->filename);
331
332 dev = add_dev("network", line, "Unknown", dent->filename, "");
333 if (!dev)
334 {
335 cupsDirClose(dir);
336 return (1);
337 }
338
e00b005a 339 fprintf(stderr, "DEBUG: [cups-deviced] Compatibility device "
340 "\"%s\"...\n", dent->filename);
ef416fc2 341 }
342 }
343 else
e00b005a 344 fprintf(stderr, "WARNING: [cups-deviced] Unable to execute \"%s\" "
345 "backend: %s\n", dent->filename, strerror(errno));
ef416fc2 346 }
347
348 cupsDirClose(dir);
349
e00b005a 350 /*
351 * Switch back to root as needed...
352 */
353
354 if (!getuid() && geteuid())
355 seteuid(0);
356
ef416fc2 357 /*
358 * Output the list of devices...
359 */
360
361 puts("Content-Type: application/ipp\n");
362
e00b005a 363 cupsdSendIPPHeader(IPP_OK, request_id);
ef416fc2 364 cupsdSendIPPGroup(IPP_TAG_OPERATION);
365 cupsdSendIPPString(IPP_TAG_CHARSET, "attributes-charset", "utf-8");
366 cupsdSendIPPString(IPP_TAG_LANGUAGE, "attributes-natural-language", "en-US");
367
368 if ((count = atoi(argv[2])) <= 0)
369 count = cupsArrayCount(devs);
370
371 if (count > cupsArrayCount(devs))
372 count = cupsArrayCount(devs);
373
374 for (dev = (dev_info_t *)cupsArrayFirst(devs);
375 count > 0;
376 count --, dev = (dev_info_t *)cupsArrayNext(devs))
377 {
378 /*
379 * Add strings to attributes...
380 */
381
382 cupsdSendIPPGroup(IPP_TAG_PRINTER);
383 if (send_class)
384 cupsdSendIPPString(IPP_TAG_KEYWORD, "device-class", dev->device_class);
385 if (send_info)
386 cupsdSendIPPString(IPP_TAG_TEXT, "device-info", dev->device_info);
387 if (send_make_and_model)
388 cupsdSendIPPString(IPP_TAG_TEXT, "device-make-and-model",
389 dev->device_make_and_model);
390 if (send_uri)
391 cupsdSendIPPString(IPP_TAG_URI, "device-uri", dev->device_uri);
392 if (send_id)
393 cupsdSendIPPString(IPP_TAG_TEXT, "device-id", dev->device_id);
394 }
395
396 cupsdSendIPPTrailer();
397
398 /*
399 * Free the devices array and return...
400 */
401
402 for (dev = (dev_info_t *)cupsArrayFirst(devs);
403 dev;
404 dev = (dev_info_t *)cupsArrayNext(devs))
405 free(dev);
406
407 cupsArrayDelete(devs);
408
409 return (0);
410}
411
412
413/*
414 * 'add_dev()' - Add a new device to the list.
415 */
416
417static dev_info_t * /* O - New device or NULL on error */
418add_dev(
419 const char *device_class, /* I - Device class */
420 const char *device_make_and_model, /* I - Device make and model */
421 const char *device_info, /* I - Device information */
422 const char *device_uri, /* I - Device URI */
423 const char *device_id) /* I - 1284 device ID */
424{
425 dev_info_t *dev; /* New device */
426
427
428 /*
429 * Allocate memory for the device record...
430 */
431
432 if ((dev = calloc(1, sizeof(dev_info_t))) == NULL)
433 {
434 fputs("ERROR: [cups-deviced] Ran out of memory allocating a device!\n",
435 stderr);
436 return (NULL);
437 }
438
439 /*
440 * Copy the strings over...
441 */
442
443 strlcpy(dev->device_class, device_class, sizeof(dev->device_class));
444 strlcpy(dev->device_make_and_model, device_make_and_model,
445 sizeof(dev->device_make_and_model));
446 strlcpy(dev->device_info, device_info, sizeof(dev->device_info));
447 strlcpy(dev->device_uri, device_uri, sizeof(dev->device_uri));
448 strlcpy(dev->device_id, device_id, sizeof(dev->device_id));
449
450 /*
451 * Add the device to the array and return...
452 */
453
454 cupsArrayAdd(devs, dev);
455
456 return (dev);
457}
458
459
460/*
461 * 'compare_devs()' - Compare device names for sorting.
462 */
463
464static int /* O - Result of comparison */
465compare_devs(dev_info_t *d0, /* I - First device */
466 dev_info_t *d1) /* I - Second device */
467{
468 int diff; /* Difference between strings */
469
470
471 /*
472 * Sort devices by device-info, device-class, and device-uri...
473 */
474
475 if ((diff = cupsdCompareNames(d0->device_info, d1->device_info)) != 0)
476 return (diff);
477 else if ((diff = strcasecmp(d0->device_class, d1->device_class)) != 0)
478 return (diff);
479 else
480 return (strcasecmp(d0->device_uri, d1->device_uri));
481}
482
483
484/*
485 * 'sigalrm_handler()' - Handle alarm signals for backends that get hung
486 * trying to list the available devices...
487 */
488
489static void
490sigalrm_handler(int sig) /* I - Signal number */
491{
492 (void)sig; /* remove compiler warnings... */
493
494 alarm_tripped = 1;
495}
496
497
498/*
bd7854cb 499 * End of "$Id: cups-deviced.c 5099 2006-02-13 02:46:10Z mike $".
ef416fc2 500 */